26089ed5b5
OBS-URL: https://build.opensuse.org/package/show/Java:packages/maven-javadoc-plugin?expand=0&rev=58
33493 lines
2.0 MiB
33493 lines
2.0 MiB
--- maven-javadoc-plugin-3.10.1/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.10.1/src/main/filtered-resources/META-INF/maven/org.apache.maven.plugins/maven-javadoc-plugin/plugin-help.xml 2024-09-30 21:23:26.893855410 +0200
|
|
@@ -0,0 +1,15697 @@
|
|
+<?xml version="1.0" encoding="UTF-8"?>
|
|
+
|
|
+<!-- Generated by maven-plugin-tools 3.15 (for help mojo with limited elements)-->
|
|
+
|
|
+<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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.
|
|
+
|
|
+Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project.
|
|
+</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency></type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.DependencyLink></type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map<java.lang.String, java.lang.String></type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList<java.lang.String></type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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}/reports"/>
|
|
+ <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>aggregate-jar</goal>
|
|
+ <description>
|
|
+Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</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.AggregatorJavadocJarMojo</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency></type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether to attach the generated artifact to the project helper.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.DependencyLink></type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directory where the generated jar file will be put.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map<java.lang.String, java.lang.String></type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList<java.lang.String></type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to enable the use of the defaultManifestFile.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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}/reports"/>
|
|
+ <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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency></type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.DependencyLink></type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map<java.lang.String, java.lang.String></type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList<java.lang.String></type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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}/reports"/>
|
|
+ <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>fix</goal>
|
|
+ <description>Fix Javadoc documentation and tags for the Java code for the project.
|
|
+See also: Where Tags Can Be Used <https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#where-tags-can-be-used></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>Version to compare the current code against using the Clirr Maven Plugin <https://www.mojohaus.org/clirr-maven-plugin/>.
|
|
+See defaultSince.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultAuthor</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Default value for the Javadoc tag @author.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultSince</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Default value for the Javadoc tag @since.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Default value for the Javadoc tag @version.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Comma separated excludes Java files, i.e. **/*Test.java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixClassComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to fix the classes or interfaces Javadoc comments according the level.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixFieldComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to fix the fields Javadoc comments according the level.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixMethodComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to fix the methods Javadoc comments according the level.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixTags</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are:
|
|
+* all (fix all Javadoc tags)
|
|
+* author (fix only @author tag)
|
|
+* version (fix only @version tag)
|
|
+* since (fix only @since tag)
|
|
+* param (fix only @param tag)
|
|
+* return (fix only @return tag)
|
|
+* throws (fix only @throws tag)
|
|
+* link (fix only @link tag) </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>force</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forcing the goal execution i.e. skip warranty messages (not recommended).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>ignoreClirr</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to ignore or not Clirr.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Comma separated includes Java files, i.e. **/*Test.java.
|
|
+
|
|
+Note: default value is **\/*.java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>level</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: private, protected, public, package options for Javadoc <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Output directory where Java classes will be rewritten.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>removeUnknownThrows</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Flag to remove throws tags from unknown classes.
|
|
+
|
|
+NOTE:Since 3.1.0 the default value has been changed to true, due to JavaDoc 8 strictness.
|
|
+</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <comparisonVersion implementation="java.lang.String" default-value="(,${project.version})">${comparisonVersion}</comparisonVersion>
|
|
+ <defaultAuthor implementation="java.lang.String" default-value="${user.name}">${defaultAuthor}</defaultAuthor>
|
|
+ <defaultSince implementation="java.lang.String" default-value="${project.version}">${defaultSince}</defaultSince>
|
|
+ <defaultVersion implementation="java.lang.String">${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.maven_javadoc_plugin.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>If true, display all settable properties for each goal.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>goal</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the goal for which to show help. If unspecified, all goals will be displayed.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>indentSize</name>
|
|
+ <type>int</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The number of spaces per indentation level, should be positive.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>lineLength</name>
|
|
+ <type>int</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The maximum length of a display line, should be positive.</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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.</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.JavadocJarMojo</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency></type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether to attach the generated artifact to the project helper.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.DependencyLink></type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directory where the generated jar file will be put.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map<java.lang.String, java.lang.String></type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList<java.lang.String></type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to enable the use of the defaultManifestFile.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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}/reports"/>
|
|
+ <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 a NON aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.
|
|
+See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html></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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency></type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.DependencyLink></type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map<java.lang.String, java.lang.String></type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList<java.lang.String></type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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}/reports"/>
|
|
+ <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>javadoc-no-fork</goal>
|
|
+ <description>Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. Note that this goal does require generation of sources before site generation, e.g. by invoking mvn clean deploy site.
|
|
+See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>, Javadoc Options <http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#options></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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency></type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.DependencyLink></type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map<java.lang.String, java.lang.String></type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList<java.lang.String></type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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}/reports"/>
|
|
+ <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>resource-bundle</goal>
|
|
+ <description>Bundle javadocDirectory, along with javadoc configuration options such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency></type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.DependencyLink></type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map<java.lang.String, java.lang.String></type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList<java.lang.String></type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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}/reports"/>
|
|
+ <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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.
|
|
+
|
|
+Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project.
|
|
+</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency></type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.DependencyLink></type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map<java.lang.String, java.lang.String></type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList<java.lang.String></type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies the Test title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.</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>The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+See also: Doclet option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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}/reports"/>
|
|
+ <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>
|
|
+ <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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</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.AggregatorTestJavadocJarMojo</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency></type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether to attach the generated artifact to the project helper.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.DependencyLink></type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directory where the generated jar file will be put.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map<java.lang.String, java.lang.String></type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList<java.lang.String></type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testClassifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description></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>Specifies the Test title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).</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>Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+See also: Doclet option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to enable the use of the defaultManifestFile.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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}/reports"/>
|
|
+ <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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency></type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.DependencyLink></type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map<java.lang.String, java.lang.String></type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList<java.lang.String></type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies the Test title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.</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>The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+See also: Doclet option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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}/reports"/>
|
|
+ <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>
|
|
+ <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.
|
|
+See also: Where Tags Can Be Used <https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#where-tags-can-be-used></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>Version to compare the current code against using the Clirr Maven Plugin <https://www.mojohaus.org/clirr-maven-plugin/>.
|
|
+See defaultSince.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultAuthor</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Default value for the Javadoc tag @author.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultSince</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Default value for the Javadoc tag @since.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Default value for the Javadoc tag @version.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Comma separated excludes Java files, i.e. **/*Test.java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixClassComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to fix the classes or interfaces Javadoc comments according the level.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixFieldComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to fix the fields Javadoc comments according the level.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixMethodComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to fix the methods Javadoc comments according the level.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixTags</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are:
|
|
+* all (fix all Javadoc tags)
|
|
+* author (fix only @author tag)
|
|
+* version (fix only @version tag)
|
|
+* since (fix only @since tag)
|
|
+* param (fix only @param tag)
|
|
+* return (fix only @return tag)
|
|
+* throws (fix only @throws tag)
|
|
+* link (fix only @link tag) </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>force</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forcing the goal execution i.e. skip warranty messages (not recommended).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>ignoreClirr</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to ignore or not Clirr.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Comma separated includes Java files, i.e. **/*Test.java.
|
|
+
|
|
+Note: default value is **\/*.java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>level</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: private, protected, public, package options for Javadoc <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Output directory where Java classes will be rewritten.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>removeUnknownThrows</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Flag to remove throws tags from unknown classes.
|
|
+
|
|
+NOTE:Since 3.1.0 the default value has been changed to true, due to JavaDoc 8 strictness.
|
|
+</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <comparisonVersion implementation="java.lang.String" default-value="(,${project.version})">${comparisonVersion}</comparisonVersion>
|
|
+ <defaultAuthor implementation="java.lang.String" default-value="${user.name}">${defaultAuthor}</defaultAuthor>
|
|
+ <defaultSince implementation="java.lang.String" default-value="${project.version}">${defaultSince}</defaultSince>
|
|
+ <defaultVersion implementation="java.lang.String">${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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.</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.TestJavadocJarMojo</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency></type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether to attach the generated artifact to the project helper.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.DependencyLink></type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directory where the generated jar file will be put.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map<java.lang.String, java.lang.String></type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList<java.lang.String></type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testClassifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description></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>Specifies the Test title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).</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>Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+See also: Doclet option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to enable the use of the defaultManifestFile.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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}/reports"/>
|
|
+ <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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.
|
|
+See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html></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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency></type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.DependencyLink></type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map<java.lang.String, java.lang.String></type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList<java.lang.String></type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies the Test title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.</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>The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+See also: Doclet option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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}/reports"/>
|
|
+ <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>
|
|
+ <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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. Note that this goal does require generation of test sources before site generation, e.g. by invoking mvn clean deploy site.
|
|
+See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>, Javadoc Options <http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#options></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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency></type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.DependencyLink></type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map<java.lang.String, java.lang.String></type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList<java.lang.String></type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies the Test title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.</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>The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+See also: Doclet option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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}/reports"/>
|
|
+ <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>
|
|
+ <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 TestJavadocJarMojo.testJavadocDirectory, along with javadoc configuration options from such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.AdditionalDependency></type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List<org.apache.maven.plugins.javadoc.DependencyLink></type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map<java.lang.String, java.lang.String></type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList<java.lang.String></type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List<java.lang.String></type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <footer implementation="java.lang.String">${footer}</footer>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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}/reports"/>
|
|
+ <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>
|
|
--- maven-javadoc-plugin-3.10.1/src/main/filtered-resources/META-INF/maven/plugin.xml 1970-01-01 01:00:00.000000000 +0100
|
|
+++ maven-javadoc-plugin-3.10.1/src/main/filtered-resources/META-INF/maven/plugin.xml 2024-09-30 21:26:00.321553178 +0200
|
|
@@ -0,0 +1,17337 @@
|
|
+<?xml version="1.0" encoding="UTF-8"?>
|
|
+
|
|
+<!-- Generated by maven-plugin-tools 3.15-->
|
|
+
|
|
+<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>
|
|
+ <requiredJavaVersion>1.8</requiredJavaVersion>
|
|
+ <requiredMavenVersion>3.5.0</requiredMavenVersion>
|
|
+ <mojos>
|
|
+ <mojo>
|
|
+ <goal>aggregate</goal>
|
|
+ <description>
|
|
+Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.
|
|
+
|
|
+Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project.
|
|
+</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojoExecution</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The projects in the reactor for aggregation report.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current build session instance. This is used for toolchain manager API calls.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Settings.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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>
|
|
+ <mojoExecution 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}/reports"/>
|
|
+ <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" default-value="${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.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.doxia.tools.SiteTool</role>
|
|
+ <field-name>siteTool</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>
|
|
+Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</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.AggregatorJavadocJarMojo</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether to attach the generated artifact to the project helper.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultManifestFile</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Path to the default MANIFEST file to use. It will be used if useDefaultManifestFile is set to true.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directory where the generated jar file will be put.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojoExecution</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The projects in the reactor for aggregation report.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current build session instance. This is used for toolchain manager API calls.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Settings.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to enable the use of the defaultManifestFile.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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"/>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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>
|
|
+ <mojoExecution 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}/reports"/>
|
|
+ <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" default-value="${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.doxia.tools.SiteTool</role>
|
|
+ <field-name>siteTool</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 Java code in an aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojoExecution</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The projects in the reactor for aggregation report.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current build session instance. This is used for toolchain manager API calls.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Settings.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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>
|
|
+ <mojoExecution 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}/reports"/>
|
|
+ <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" default-value="${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.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.doxia.tools.SiteTool</role>
|
|
+ <field-name>siteTool</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 Java code for the project.
|
|
+See also: Where Tags Can Be Used <https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#where-tags-can-be-used></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>Version to compare the current code against using the Clirr Maven Plugin <https://www.mojohaus.org/clirr-maven-plugin/>.
|
|
+See defaultSince.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultAuthor</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Default value for the Javadoc tag @author.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultSince</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Default value for the Javadoc tag @since.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Default value for the Javadoc tag @version.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Comma separated excludes Java files, i.e. **/*Test.java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixClassComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to fix the classes or interfaces Javadoc comments according the level.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixFieldComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to fix the fields Javadoc comments according the level.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixMethodComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to fix the methods Javadoc comments according the level.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixTags</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are:
|
|
+* all (fix all Javadoc tags)
|
|
+* author (fix only @author tag)
|
|
+* version (fix only @version tag)
|
|
+* since (fix only @since tag)
|
|
+* param (fix only @param tag)
|
|
+* return (fix only @return tag)
|
|
+* throws (fix only @throws tag)
|
|
+* link (fix only @link tag) </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>force</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forcing the goal execution i.e. skip warranty messages (not recommended).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>ignoreClirr</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to ignore or not Clirr.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Comma separated includes Java files, i.e. **/*Test.java.
|
|
+
|
|
+Note: default value is **\/*.java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>level</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: private, protected, public, package options for Javadoc <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Output directory where Java classes will be rewritten.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>removeUnknownThrows</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Flag to remove throws tags from unknown classes.
|
|
+
|
|
+NOTE:Since 3.1.0 the default value has been changed to true, due to JavaDoc 8 strictness.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current user system settings for use in Maven.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <comparisonVersion implementation="java.lang.String" default-value="(,${project.version})">${comparisonVersion}</comparisonVersion>
|
|
+ <defaultAuthor implementation="java.lang.String" default-value="${user.name}">${defaultAuthor}</defaultAuthor>
|
|
+ <defaultSince implementation="java.lang.String" default-value="${project.version}">${defaultSince}</defaultSince>
|
|
+ <defaultVersion implementation="java.lang.String">${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.
|
|
+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.maven_javadoc_plugin.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>If true, display all settable properties for each goal.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>goal</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the goal for which to show help. If unspecified, all goals will be displayed.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>indentSize</name>
|
|
+ <type>int</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The number of spaces per indentation level, should be positive.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>lineLength</name>
|
|
+ <type>int</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The maximum length of a display line, should be positive.</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 <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.</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.JavadocJarMojo</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether to attach the generated artifact to the project helper.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultManifestFile</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Path to the default MANIFEST file to use. It will be used if useDefaultManifestFile is set to true.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directory where the generated jar file will be put.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojoExecution</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The projects in the reactor for aggregation report.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current build session instance. This is used for toolchain manager API calls.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Settings.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to enable the use of the defaultManifestFile.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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"/>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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>
|
|
+ <mojoExecution 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}/reports"/>
|
|
+ <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" default-value="${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.doxia.tools.SiteTool</role>
|
|
+ <field-name>siteTool</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 Java code in a NON aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.
|
|
+See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html></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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojoExecution</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The projects in the reactor for aggregation report.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current build session instance. This is used for toolchain manager API calls.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Settings.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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>
|
|
+ <mojoExecution 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}/reports"/>
|
|
+ <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" default-value="${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.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.doxia.tools.SiteTool</role>
|
|
+ <field-name>siteTool</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 Java code in an NON aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. Note that this goal does require generation of sources before site generation, e.g. by invoking mvn clean deploy site.
|
|
+See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>, Javadoc Options <http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#options></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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojoExecution</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The projects in the reactor for aggregation report.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current build session instance. This is used for toolchain manager API calls.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Settings.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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>
|
|
+ <mojoExecution 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}/reports"/>
|
|
+ <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" default-value="${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.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.doxia.tools.SiteTool</role>
|
|
+ <field-name>siteTool</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 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>addStylesheets</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Base name of artifacts produced by this project. This will be combined with getAttachmentClassifier() to produce the name for this bundle jar.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojoExecution</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The projects in the reactor for aggregation report.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current build session instance. This is used for toolchain manager API calls.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Settings.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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>
|
|
+ <mojoExecution 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}/reports"/>
|
|
+ <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" default-value="${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.doxia.tools.SiteTool</role>
|
|
+ <field-name>siteTool</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>
|
|
+Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.
|
|
+
|
|
+Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project.
|
|
+</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojoExecution</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The projects in the reactor for aggregation report.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current build session instance. This is used for toolchain manager API calls.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Settings.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies the Test title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.</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>The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+See also: Doclet option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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>
|
|
+ <mojoExecution 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}/reports"/>
|
|
+ <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" default-value="${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>
|
|
+ <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.doxia.tools.SiteTool</role>
|
|
+ <field-name>siteTool</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>
|
|
+Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.
|
|
+
|
|
+Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
|
|
+</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.AggregatorTestJavadocJarMojo</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether to attach the generated artifact to the project helper.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultManifestFile</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Path to the default MANIFEST file to use. It will be used if useDefaultManifestFile is set to true.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directory where the generated jar file will be put.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojoExecution</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The projects in the reactor for aggregation report.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current build session instance. This is used for toolchain manager API calls.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Settings.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testClassifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description></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>Specifies the Test title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).</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>Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+See also: Doclet option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to enable the use of the defaultManifestFile.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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"/>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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>
|
|
+ <mojoExecution 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}/reports"/>
|
|
+ <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" default-value="${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.doxia.tools.SiteTool</role>
|
|
+ <field-name>siteTool</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 Java Test code in an aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojoExecution</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The projects in the reactor for aggregation report.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current build session instance. This is used for toolchain manager API calls.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Settings.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies the Test title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.</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>The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+See also: Doclet option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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>
|
|
+ <mojoExecution 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}/reports"/>
|
|
+ <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" default-value="${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>
|
|
+ <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.doxia.tools.SiteTool</role>
|
|
+ <field-name>siteTool</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 Test Java code for the project.
|
|
+See also: Where Tags Can Be Used <https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#where-tags-can-be-used></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>Version to compare the current code against using the Clirr Maven Plugin <https://www.mojohaus.org/clirr-maven-plugin/>.
|
|
+See defaultSince.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultAuthor</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Default value for the Javadoc tag @author.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultSince</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Default value for the Javadoc tag @since.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Default value for the Javadoc tag @version.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Comma separated excludes Java files, i.e. **/*Test.java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixClassComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to fix the classes or interfaces Javadoc comments according the level.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixFieldComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to fix the fields Javadoc comments according the level.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixMethodComment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to fix the methods Javadoc comments according the level.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>fixTags</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are:
|
|
+* all (fix all Javadoc tags)
|
|
+* author (fix only @author tag)
|
|
+* version (fix only @version tag)
|
|
+* since (fix only @since tag)
|
|
+* param (fix only @param tag)
|
|
+* return (fix only @return tag)
|
|
+* throws (fix only @throws tag)
|
|
+* link (fix only @link tag) </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>force</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forcing the goal execution i.e. skip warranty messages (not recommended).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>ignoreClirr</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag to ignore or not Clirr.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includes</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Comma separated includes Java files, i.e. **/*Test.java.
|
|
+
|
|
+Note: default value is **\/*.java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>level</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: private, protected, public, package options for Javadoc <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Output directory where Java classes will be rewritten.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>removeUnknownThrows</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Flag to remove throws tags from unknown classes.
|
|
+
|
|
+NOTE:Since 3.1.0 the default value has been changed to true, due to JavaDoc 8 strictness.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current user system settings for use in Maven.</description>
|
|
+ </parameter>
|
|
+ </parameters>
|
|
+ <configuration>
|
|
+ <comparisonVersion implementation="java.lang.String" default-value="(,${project.version})">${comparisonVersion}</comparisonVersion>
|
|
+ <defaultAuthor implementation="java.lang.String" default-value="${user.name}">${defaultAuthor}</defaultAuthor>
|
|
+ <defaultSince implementation="java.lang.String" default-value="${project.version}">${defaultSince}</defaultSince>
|
|
+ <defaultVersion implementation="java.lang.String">${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 test Java code in an NON aggregator project into a jar using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.</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.TestJavadocJarMojo</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>archive</name>
|
|
+ <type>org.apache.maven.archiver.MavenArchiveConfiguration</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The archive configuration to use. See Maven Archiver Reference <http://maven.apache.org/shared/maven-archiver/index.html>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>attach</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether to attach the generated artifact to the project helper.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>classifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>defaultManifestFile</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.5</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Path to the default MANIFEST file to use. It will be used if useDefaultManifestFile is set to true.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jarOutputDirectory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directory where the generated jar file will be put.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojoExecution</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The projects in the reactor for aggregation report.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current build session instance. This is used for toolchain manager API calls.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Settings.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testClassifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.10</since>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description></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>Specifies the Test title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).</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>Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+See also: Doclet option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useDefaultManifestFile</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to enable the use of the defaultManifestFile.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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"/>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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>
|
|
+ <mojoExecution 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}/reports"/>
|
|
+ <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" default-value="${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.doxia.tools.SiteTool</role>
|
|
+ <field-name>siteTool</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 Java Test code in an NON aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>.
|
|
+See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html></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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojoExecution</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The projects in the reactor for aggregation report.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current build session instance. This is used for toolchain manager API calls.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Settings.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies the Test title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.</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>The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+See also: Doclet option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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>
|
|
+ <mojoExecution 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}/reports"/>
|
|
+ <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" default-value="${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>
|
|
+ <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.doxia.tools.SiteTool</role>
|
|
+ <field-name>siteTool</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 Java Test code in an NON aggregator project using the standard Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>. Note that this goal does require generation of test sources before site generation, e.g. by invoking mvn clean deploy site.
|
|
+See also: Javadoc Tool <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html>, Javadoc Options <http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#options></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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>description</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojoExecution</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>name</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The projects in the reactor for aggregation report.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current build session instance. This is used for toolchain manager API calls.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Settings.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies the Test title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.</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>The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).</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>Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+See also: Doclet option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Test title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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>
|
|
+ <mojoExecution 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}/reports"/>
|
|
+ <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" default-value="${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>
|
|
+ <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.doxia.tools.SiteTool</role>
|
|
+ <field-name>siteTool</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 TestJavadocJarMojo.testJavadocDirectory, along with javadoc configuration options from such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.</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>Specifies the path of an additional HTML stylesheet file relative to the javadocDirectory Example: <addStylesheets> <addStylesheet>resources/addstylesheet.css</addStylesheet> </addStylesheets> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalDependencies</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.8.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Capability to add additional dependencies to the javadoc classpath. Example: <additionalDependencies> <additionalDependency> <groupId>geronimo-spec</groupId> <artifactId>geronimo-spec-jta</artifactId> <version>1.0.1B-rc4</version> </additionalDependency> </additionalDependencies> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOption</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options (e.g. JVM options) on the command line. Example: <additionalJOption>-J-Xss128m</additionalJOption>
|
|
+See also: Javadoc Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>, VM Options <https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options>, Networking Properties <https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalJOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets additional Javadoc options for the execution of the javadoc command via the '-J' option to javadoc. Example: <additionalJOptions> <additionalJOption>-J-Xmx1g </additionalJOption> </additionalJOptions>
|
|
+See also: additionalJOption</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>additionalOptions</name>
|
|
+ <type>java.lang.String[]</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set an additional option(s) on the command line. All input will be passed as-is to the @options file. You must take care of quoting and escaping. Useful for a custom doclet.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>applyJavadocSecurityFix</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.9.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>To apply a security fix on generated javadoc, see</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>author</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether or not the author text is included in the generated Javadocs.
|
|
+See also: Doclet option author <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bootclasspath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path>.</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>Specifies the artifacts where the boot classes reside.
|
|
+Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
|
|
+See Javadoc.
|
|
+See also: Javadoc option bootclasspath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-boot-class-path></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>bottom</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the text to be placed at the bottom of each output file.
|
|
+If you want to use html, you have to put it in a CDATA section,
|
|
+e.g. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]>
|
|
+Note:If the project has the property project.build.outputTimestamp, its year will be used as {currentYear}. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option bottom <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>breakiterator</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Uses the sentence break iterator to determine the end of the first sentence.
|
|
+See also: Javadoc option breakiterator <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>charset</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the HTML character set for this document. If not specified, the charset value will be the value of the docencoding parameter.
|
|
+See also: Doclet option charset <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>debug</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencyLinks</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>3.3.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Redefine the apidoc URL for specific dependencies when using detectLinks. Useful if the dependency wasn't build with Maven or when the apidocs have been moved. <dependencyLinks> <dependencyLink> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <classifier>classifier</classifier> <!-- optional --> <url>version</url> </dependencyLink> </dependencyLinks>
|
|
+See also: detectLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of excluded dependency-source patterns. Example: org.apache.maven.shared:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>dependencySourceIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>List of included dependency-source patterns. Example: org.apache.maven:*
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectJavaApiLink</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Java API link for the current build, e.g. https://docs.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.
|
|
+By default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.
|
|
+See also: links, javaApiLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.
|
|
+For instance, if the project has a dependency to Apache Commons Lang <http://commons.apache.org/lang/> i.e.: <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> </dependency> The added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.
|
|
+See also: links, dependencyLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>detectOfflineLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Detect the links for all modules defined in the project.
|
|
+If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
|
|
+The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
|
|
+The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs
|
|
+See also: offlineLinks</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docencoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding of the generated HTML files. If not specified, the docencoding value will be UTF-8.
|
|
+See also: Doclet option docencoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docfilessubdirs</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).
|
|
+See also: Doclet option docfilessubdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., excludedocfilessubdir, javadocDirectory</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the doclet used in generating the documentation.
|
|
+See also: Javadoc option doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletArtifact</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.DocletArtifact</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the artifact containing the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</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>Specifies multiple artifacts containing the path for the doclet starting class file (specified with the doclet option).
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>docletPath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path to the doclet starting class file (specified with the doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option docletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doclint</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies specific checks to be performed on Javadoc comments.
|
|
+See also: Additional Doclet option Xdoclint <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>doctitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed near the top of the overview summary file.
|
|
+See also: Doclet option doctitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>encoding</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the encoding name of the source files. If not specified, the encoding value will be the value of the file.encoding system property.
|
|
+Note: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.
|
|
+See also: Javadoc option encoding <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-encoding>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludePackageNames</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).
|
|
+Wildcards work as followed:
|
|
+
|
|
+* a wildcard at the beginning should match one or more directories
|
|
+* any other wildcard must match exactly one directory
|
|
+
|
|
+Example: <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>
|
|
+See also: Javadoc option exclude <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>excludedocfilessubdir</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).
|
|
+See also: Doclet option excludedocfilessubdir <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>extdirs</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option extdirs <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-extdirs>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnError</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are errors during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>failOnWarnings</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.0.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies if the build will fail if there are warning during javadoc execution or not.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>finalName</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Base name of artifacts produced by this project. This will be combined with getAttachmentClassifier() to produce the name for this bundle jar.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>footer</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the footer text to be placed at the bottom of each output file.
|
|
+See also: Doclet option footer <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>forceRootLocale</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.8.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Forces the Javadoc JVM locale to be java.util.Locale.ROOT. This will force the Javadoc output on stdout and stderr to be in English only and the generated HTML content in English as well. If you need the generated HTML content in another supported language use locale.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>groups</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Group[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning "match any characters". Multiple patterns can be included in a group by separating them with colons (:).
|
|
+Example: <groups> <group> <title>Core Packages</title> <!-- To includes java.lang, java.lang.ref, java.lang.reflect and only java.util (i.e. not java.util.jar) --> <packages>java.lang*:java.util</packages> </group> <group> <title>Extension Packages</title> <!-- To include javax.accessibility, javax.crypto, ... (among others) --> <packages>javax.*</packages> </group> </groups> Note: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.
|
|
+See also: Doclet option group <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>., org.apache.maven.plugins.javadoc.options.Group</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>header</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the header text to be placed at the top of each output file.
|
|
+See also: Doclet option header <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>helpfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom navigation bars link to.
|
|
+Note: could be in conflict with <nohelp/>.
|
|
+The helpfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> Where path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option helpfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>includeDependencySources</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.</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>Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javaApiLinks</name>
|
|
+ <type>java.util.Properties</type>
|
|
+ <since>2.6</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Use this parameter only if if you want to override the default URLs. The key should match api_x, where x matches the Java version. For example: api_1.5
|
|
+https://docs.oracle.com/javase/1.5.0/docs/api/
|
|
+api_1.8
|
|
+
|
|
+https://docs.oracle.com/javase/8/docs/api/
|
|
+api_9
|
|
+https://docs.oracle.com/javase/9/docs/api/
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
|
|
+Could be used in addition of docfilessubdirs parameter.
|
|
+See docfilessubdirs.
|
|
+See also: docfilessubdirs</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocExecutable</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocOptionsDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>false</editable>
|
|
+ <description>Directory into which assembled org.apache.maven.plugins.javadoc.options.JavadocOptions instances will be written before they are added to javadoc resources bundles.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>javadocVersion</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.3</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>jdkToolchain</name>
|
|
+ <type>java.util.Map</type>
|
|
+ <since>3.0.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Allow for configuration of the javadoc tool via maven toolchains. This overrules the toolchain selected by the maven-toolchain-plugin.
|
|
+
|
|
+Examples:
|
|
+(see Guide to Toolchains <https://maven.apache.org/guides/mini/guide-using-toolchains.html> for more info) <configuration> ... <jdkToolchain> <version>11</version> </jdkToolchain> </configuration> <configuration> ... <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> </configuration> note: requires at least Maven 3.3.1</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>keywords</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Adds HTML meta keyword tags to the generated file for each class.
|
|
+See also: Doclet option keywords <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>legacyMode</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is post java 9. This allows non-JPMS projects that have moved to newer Java versions to create javadocs without having to use JPMS modules.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>links</name>
|
|
+ <type>java.util.ArrayList</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates links to existing javadoc-generated documentation of external referenced classes.
|
|
+Notes:
|
|
+
|
|
+* This option is ignored if the plugin is run in offline mode (using the <offline> setting or specifying -o, --offline or -Dmaven.javadoc.offline=true on the command line.
|
|
+* all given links should have a fetchable /package-list or /element-list (since Java 10). For instance: <links> <link>https://docs.oracle.com/en/java/javase/17/docs/api</link> <links> will be used because https://docs.oracle.com/en/java/javase/17/docs/api/element-list exists.
|
|
+* If detectLinks is defined, the links between the project dependencies are automatically added.
|
|
+* If detectJavaApiLink is defined, a Java API link, based on the Java version of the project's sources, will be added automatically.
|
|
+See also: Doclet option link <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>linksource</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.
|
|
+See also: Doclet option linksource/a>.
|
|
+<https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>locale</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the locale that javadoc uses when generating documentation.
|
|
+See also: Javadoc option locale <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>maxmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>minmemory</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: '512' or '512m'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>mojoExecution</name>
|
|
+ <type>org.apache.maven.plugin.MojoExecution</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nocomment</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppress the entire comment body, including the main description and all tags, generating only declarations.
|
|
+See also: Doclet option nocomment <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecated</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of any deprecated API at all in the documentation.
|
|
+See also: Doclet option nodeprecated <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nodeprecatedlist</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.
|
|
+See also: Doclet option nodeprecatedlist <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nohelp</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the HELP link in the navigation bars at the top and bottom of each page of output.
|
|
+Note: could be in conflict with helpfile.
|
|
+See also: Doclet option nohelp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the index from the generated docs.
|
|
+Note: could be in conflict with splitindex
|
|
+See also: Doclet option noindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nonavbar</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the navigation bar from the generated docs.
|
|
+See also: Doclet option nonavbar <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nooverview</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the entire overview page from the generated docs.
|
|
+Note: could be in conflict with overview.
|
|
+Standard Doclet undocumented option.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>noqualifier</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits qualifying package name from ahead of class names in output. Example: <noqualifier>all</noqualifier> or <noqualifier>packagename1:packagename2</noqualifier>
|
|
+See also: Doclet option noqualifier <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>nosince</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits from the generated docs the "Since" sections associated with the since tags.
|
|
+See also: Doclet option nosince <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notimestamp</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
|
|
+
|
|
+Note: If the project has the property project.build.outputTimestamp, the value will be overwritten to true. This way it is possible to generate reproducible javadoc jars.
|
|
+See also: Doclet option notimestamp <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>notree</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Omits the class/interface hierarchy pages from the generated docs.
|
|
+See also: Doclet option notree <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offline</name>
|
|
+ <type>boolean</type>
|
|
+ <since>3.6.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify if the Javadoc plugin should operate in offline mode. If maven is run in offline mode (using -o or --offline on the command line), this option has no effect and the plugin is always in offline mode.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>offlineLinks</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.OfflineLink[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option is a variation of links; they both create links to javadoc-generated documentation for external referenced classes.
|
|
+Example: <offlineLinks> <offlineLink> <url>https://docs.oracle.com/javase/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
|
|
+Note: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.
|
|
+See also: org.apache.maven.plugins.javadoc.options.OfflineLink, Doclet option linkoffline <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>old</name>
|
|
+ <type>boolean</type>
|
|
+ <deprecated>No reason given</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1. This is no longer supported since Javadoc 1.4 (shipped with JDK 1.4)
|
|
+See also: Javadoc option 1.1 <https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#a1.1>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputDirectory</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>true</required>
|
|
+ <editable>true</editable>
|
|
+ <description>The shared output directory for the report where Javadoc saves the generated HTML files. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin <https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory> is used instead.
|
|
+See also: org.apache.maven.reporting.AbstractMavenReport.outputDirectory, Doclet option d <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>outputTimestamp</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH <https://reproducible-builds.org/docs/source-date-epoch/>).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>overview</name>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
|
|
+Note: could be in conflict with nooverview.
|
|
+See also: Javadoc option overview <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>packagesheader</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the text for upper left frame.
|
|
+See also: Bug Report about missing documentation <https://bugs.openjdk.org/browse/JDK-4770521></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>project</name>
|
|
+ <type>org.apache.maven.project.MavenProject</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Project Object</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>quiet</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
|
|
+Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=4714350>).
|
|
+Since Java 5.0.
|
|
+See also: Javadoc option quiet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>reactorProjects</name>
|
|
+ <type>java.util.List</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The projects in the reactor for aggregation report.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>release</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>JDK 9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release
|
|
+See also: Javadoc option release <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-release>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>repoSession</name>
|
|
+ <type>org.eclipse.aether.RepositorySystemSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description></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>A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).
|
|
+Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
|
|
+See Javadoc.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>serialwarn</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Generates compile-time warnings for missing serial tags.
|
|
+See also: Doclet option serialwarn <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>session</name>
|
|
+ <type>org.apache.maven.execution.MavenSession</type>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The current build session instance. This is used for toolchain manager API calls.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>settings</name>
|
|
+ <type>org.apache.maven.settings.Settings</type>
|
|
+ <since>2.3</since>
|
|
+ <required>true</required>
|
|
+ <editable>false</editable>
|
|
+ <description>The Maven Settings.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>show</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the access level for classes and members to show in the Javadocs. Possible values are:
|
|
+* public (shows only public classes and members)
|
|
+* protected (shows only public and protected classes and members)
|
|
+* package (shows all classes and members not marked private)
|
|
+* private (shows all classes and members)
|
|
+See also: Javadoc options private, protected, public and package <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skip</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the Javadoc generation should be skipped.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>skippedModules</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Comma separated list of modules (artifactId) to not add in aggregated javadoc
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>source</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provide source compatibility with specified release. Since JDK 9 rather use release.
|
|
+See also: Javadoc option source <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceDependencyCacheDir</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>2.7</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Directory where unpacked project sources / test-sources should be cached.
|
|
+See also: includeDependencySources</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileExcludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>exclude filters on the source files. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourceFileIncludes</name>
|
|
+ <type>java.util.List</type>
|
|
+ <since>2.9</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Include filters on the source files. Default is **\/\*.java. These are ignored if you specify subpackages or subpackage excludes.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcepath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Javadoc option sourcepath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-source-path>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>sourcetab</name>
|
|
+ <alias>linksourcetab</alias>
|
|
+ <type>int</type>
|
|
+ <since>2.1</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.
|
|
+See also: Doclet option sourcetab <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>splitindex</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.
|
|
+Note: could be in conflict with noindex.
|
|
+See also: Doclet option splitindex <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>staleDataPath</name>
|
|
+ <type>java.io.File</type>
|
|
+ <since>3.2.0</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>
|
|
+Location of the file used to store the state of the previous javadoc run. This is used to skip the generation if nothing has changed.
|
|
+</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <deprecated>This is no longer evaluated, instead use addStylesheets to customize the CSS.</deprecated>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies whether the stylesheet to be used is the maven's javadoc stylesheet or java's default stylesheet when a stylesheetfile parameter is not specified.
|
|
+Possible values: maven or java.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>stylesheetfile</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the path of an alternate HTML stylesheet file.
|
|
+The stylesheetfile could be an absolute File path.
|
|
+Since 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance: <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> Where path/to/your/resource/yourstylesheet.css could be in src/main/javadoc. <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile> ... </configuration> <dependencies> <dependency> <groupId>groupId</groupId> <artifactId>artifactId</artifactId> <version>version</version> </dependency> </dependencies> </plugin> ... <plugins> </build> Where path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.
|
|
+See also: Doclet option stylesheetfile <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>subpackages</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).
|
|
+See also: Javadoc option subpackages <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>taglet</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the class file that starts the taglet used in generating the documentation for that tag.
|
|
+See also: Doclet option taglet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies the Taglet artifact containing the taglet class files (.class).
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
|
|
+See Javadoc.
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.
|
|
+Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
|
|
+See Javadoc.
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tagletpath</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semicolon (;).
|
|
+See also: Doclet option tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>Enables the Javadoc tool to interpret multiple taglets.
|
|
+Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
|
|
+See Javadoc.
|
|
+
|
|
+See also: Doclet options taglet and tagletpath <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options></description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>tags</name>
|
|
+ <type>org.apache.maven.plugins.javadoc.options.Tag[]</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.
|
|
+Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> Note: the placement should be a combinaison of Xaoptcmf letters:
|
|
+* X (disable tag)
|
|
+* a (all)
|
|
+* o (overview)
|
|
+* p (packages)
|
|
+* t (types, that is classes and interfaces)
|
|
+* c (constructors)
|
|
+* m (methods)
|
|
+* f (fields) See Javadoc.
|
|
+See also: Doclet option tag <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>testJavadocDirectory</name>
|
|
+ <alias>javadocDirectory</alias>
|
|
+ <type>java.io.File</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>top</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <since>2.4</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the top text to be placed at the top of each output file.
|
|
+See also: Java Bug 6227616 <https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6227616>., Doclet option top <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>use</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes one "Use" page for each documented class and package.
|
|
+See also: Doclet option use <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>useStandardDocletOptions</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.5</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies to use the options provided by the Standard Doclet <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options> for a custom doclet.
|
|
+Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> </description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>validateLinks</name>
|
|
+ <type>boolean</type>
|
|
+ <since>2.8</since>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Flag controlling content validation of package-list/element-list resources. If set, the content of package-list/element-list resources will be validated.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>verbose</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Provides more detailed messages while javadoc is running.
|
|
+See also: Javadoc option verbose <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#options-for-javadoc>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>version</name>
|
|
+ <type>boolean</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Includes the given version text in the generated docs.
|
|
+See also: Doclet option version <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</description>
|
|
+ </parameter>
|
|
+ <parameter>
|
|
+ <name>windowtitle</name>
|
|
+ <type>java.lang.String</type>
|
|
+ <required>false</required>
|
|
+ <editable>true</editable>
|
|
+ <description>Specifies the title to be placed in the HTML title tag.
|
|
+See also: Doclet option windowtitle <https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options>.</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>
|
|
+ <forceRootLocale implementation="boolean" default-value="true">${forceRootLocale}</forceRootLocale>
|
|
+ <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>
|
|
+ <mojoExecution 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}/reports"/>
|
|
+ <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" default-value="${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.doxia.tools.SiteTool</role>
|
|
+ <field-name>siteTool</field-name>
|
|
+ </requirement>
|
|
+ <requirement>
|
|
+ <role>org.apache.maven.toolchain.ToolchainManager</role>
|
|
+ <field-name>toolchainManager</field-name>
|
|
+ </requirement>
|
|
+ </requirements>
|
|
+ </mojo>
|
|
+ </mojos>
|
|
+ <dependencies>
|
|
+ <dependency>
|
|
+ <groupId>org.eclipse.sisu</groupId>
|
|
+ <artifactId>org.eclipse.sisu.plexus</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>0.9.0.M2</version>
|
|
+ </dependency>
|
|
+ <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.8.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>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-interpolation</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.27</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.resolver</groupId>
|
|
+ <artifactId>maven-resolver-util</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.4.1</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>4.0.0-M12</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.doxia</groupId>
|
|
+ <artifactId>doxia-core</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.0.0-M12</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.doxia</groupId>
|
|
+ <artifactId>doxia-site-model</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.0.0-M19</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven</groupId>
|
|
+ <artifactId>maven-archiver</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>3.6.2</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.shared</groupId>
|
|
+ <artifactId>maven-invoker</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>3.3.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.4.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.doxia</groupId>
|
|
+ <artifactId>doxia-sink-api</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.0.0-M12</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.doxia</groupId>
|
|
+ <artifactId>doxia-site-renderer</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.0.0-M19</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.doxia</groupId>
|
|
+ <artifactId>doxia-skin-model</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.0.0-M19</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.velocity</groupId>
|
|
+ <artifactId>velocity-engine-core</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.3</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-velocity</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.1.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.doxia</groupId>
|
|
+ <artifactId>doxia-module-xhtml5</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.0.0-M12</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.maven.doxia</groupId>
|
|
+ <artifactId>doxia-integration-tools</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.0.0-M19</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.wagon</groupId>
|
|
+ <artifactId>wagon-provider-api</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>3.5.3</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.commons</groupId>
|
|
+ <artifactId>commons-lang3</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>3.17.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.apache.commons</groupId>
|
|
+ <artifactId>commons-text</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.12.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>1.2</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>commons-codec</groupId>
|
|
+ <artifactId>commons-codec</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.11</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.1.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-java</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.2.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.ow2.asm</groupId>
|
|
+ <artifactId>asm</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>9.6</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-utils</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>4.0.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-xml</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>4.0.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-io</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>3.5.1</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-archiver</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>4.10.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.26.2</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>commons-io</groupId>
|
|
+ <artifactId>commons-io</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>2.17.0</version>
|
|
+ </dependency>
|
|
+ <dependency>
|
|
+ <groupId>org.codehaus.plexus</groupId>
|
|
+ <artifactId>plexus-interactivity-api</artifactId>
|
|
+ <type>jar</type>
|
|
+ <version>1.3</version>
|
|
+ </dependency>
|
|
+ </dependencies>
|
|
+</plugin>
|
|
maven-javadoc-plugin-3.10.1/src/main/java/org/apache/maven/plugins/maven_javadoc_plugin/HelpMojo.java
|
|
--- maven-javadoc-plugin-3.10.1/src/main/java/org/apache/maven/plugins/maven_javadoc_plugin/HelpMojo.java 1970-01-01 01:00:00.000000000 +0100
|
|
+++ maven-javadoc-plugin-3.10.1/src/main/java/org/apache/maven/plugins/maven_javadoc_plugin/HelpMojo.java 2024-09-30 21:20:45.172765329 +0200
|
|
@@ -0,0 +1,448 @@
|
|
+package org.apache.maven.plugins.maven_javadoc_plugin;
|
|
+
|
|
+import org.apache.maven.plugin.AbstractMojo;
|
|
+import org.apache.maven.plugin.MojoExecutionException;
|
|
+import org.apache.maven.plugins.annotations.Mojo;
|
|
+import org.apache.maven.plugins.annotations.Parameter;
|
|
+
|
|
+import org.w3c.dom.Document;
|
|
+import org.w3c.dom.Element;
|
|
+import org.w3c.dom.Node;
|
|
+import org.w3c.dom.NodeList;
|
|
+import org.xml.sax.SAXException;
|
|
+
|
|
+import javax.xml.parsers.DocumentBuilder;
|
|
+import javax.xml.parsers.DocumentBuilderFactory;
|
|
+import javax.xml.parsers.ParserConfigurationException;
|
|
+import java.io.IOException;
|
|
+import java.io.InputStream;
|
|
+import java.util.ArrayList;
|
|
+import java.util.List;
|
|
+
|
|
+/**
|
|
+ * Display help information on maven-javadoc-plugin.<br>
|
|
+ * Call <code>mvn javadoc:help -Ddetail=true -Dgoal=<goal-name></code> to display parameter details.
|
|
+ * @author maven-plugin-tools
|
|
+ */
|
|
+@Mojo( name = "help", requiresProject = false, threadSafe = true )
|
|
+public class HelpMojo
|
|
+ extends AbstractMojo
|
|
+{
|
|
+ /**
|
|
+ * If <code>true</code>, display all settable properties for each goal.
|
|
+ *
|
|
+ */
|
|
+ @Parameter( property = "detail", defaultValue = "false" )
|
|
+ private boolean detail;
|
|
+
|
|
+ /**
|
|
+ * The name of the goal for which to show help. If unspecified, all goals will be displayed.
|
|
+ *
|
|
+ */
|
|
+ @Parameter( property = "goal" )
|
|
+ private java.lang.String goal;
|
|
+
|
|
+ /**
|
|
+ * The maximum length of a display line, should be positive.
|
|
+ *
|
|
+ */
|
|
+ @Parameter( property = "lineLength", defaultValue = "80" )
|
|
+ private int lineLength;
|
|
+
|
|
+ /**
|
|
+ * The number of spaces per indentation level, should be positive.
|
|
+ *
|
|
+ */
|
|
+ @Parameter( property = "indentSize", defaultValue = "2" )
|
|
+ private int indentSize;
|
|
+
|
|
+ // /META-INF/maven/<groupId>/<artifactId>/plugin-help.xml
|
|
+ private static final String PLUGIN_HELP_PATH =
|
|
+ "/META-INF/maven/org.apache.maven.plugins/maven-javadoc-plugin/plugin-help.xml";
|
|
+
|
|
+ private static final int DEFAULT_LINE_LENGTH = 80;
|
|
+
|
|
+ private Document build()
|
|
+ throws MojoExecutionException
|
|
+ {
|
|
+ getLog().debug( "load plugin-help.xml: " + PLUGIN_HELP_PATH );
|
|
+ try ( InputStream is = getClass().getResourceAsStream( PLUGIN_HELP_PATH ) )
|
|
+ {
|
|
+ if ( is == null )
|
|
+ {
|
|
+ throw new MojoExecutionException( "Could not find plugin descriptor at " + PLUGIN_HELP_PATH );
|
|
+ }
|
|
+ DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
|
|
+ DocumentBuilder dBuilder = dbFactory.newDocumentBuilder();
|
|
+ return dBuilder.parse( is );
|
|
+ }
|
|
+ catch ( IOException e )
|
|
+ {
|
|
+ throw new MojoExecutionException( e.getMessage(), e );
|
|
+ }
|
|
+ catch ( ParserConfigurationException e )
|
|
+ {
|
|
+ throw new MojoExecutionException( e.getMessage(), e );
|
|
+ }
|
|
+ catch ( SAXException e )
|
|
+ {
|
|
+ throw new MojoExecutionException( e.getMessage(), e );
|
|
+ }
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * {@inheritDoc}
|
|
+ */
|
|
+ @Override
|
|
+ public void execute()
|
|
+ throws MojoExecutionException
|
|
+ {
|
|
+ if ( lineLength <= 0 )
|
|
+ {
|
|
+ getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." );
|
|
+ lineLength = DEFAULT_LINE_LENGTH;
|
|
+ }
|
|
+ if ( indentSize <= 0 )
|
|
+ {
|
|
+ getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." );
|
|
+ indentSize = 2;
|
|
+ }
|
|
+
|
|
+ Document doc = build();
|
|
+
|
|
+ StringBuilder sb = new StringBuilder();
|
|
+ Node plugin = getSingleChild( doc, "plugin" );
|
|
+
|
|
+
|
|
+ String name = getValue( plugin, "name" );
|
|
+ String version = getValue( plugin, "version" );
|
|
+ String id = getValue( plugin, "groupId" ) + ":" + getValue( plugin, "artifactId" ) + ":" + version;
|
|
+ if ( isNotEmpty( name ) && !name.contains( id ) )
|
|
+ {
|
|
+ append( sb, name + " " + version, 0 );
|
|
+ }
|
|
+ else
|
|
+ {
|
|
+ if ( isNotEmpty( name ) )
|
|
+ {
|
|
+ append( sb, name, 0 );
|
|
+ }
|
|
+ else
|
|
+ {
|
|
+ append( sb, id, 0 );
|
|
+ }
|
|
+ }
|
|
+ append( sb, getValue( plugin, "description" ), 1 );
|
|
+ append( sb, "", 0 );
|
|
+
|
|
+ //<goalPrefix>plugin</goalPrefix>
|
|
+ String goalPrefix = getValue( plugin, "goalPrefix" );
|
|
+
|
|
+ Node mojos1 = getSingleChild( plugin, "mojos" );
|
|
+
|
|
+ List<Node> mojos = findNamedChild( mojos1, "mojo" );
|
|
+
|
|
+ if ( goal == null || goal.length() <= 0 )
|
|
+ {
|
|
+ append( sb, "This plugin has " + mojos.size() + ( mojos.size() > 1 ? " goals:" : " goal:" ), 0 );
|
|
+ append( sb, "", 0 );
|
|
+ }
|
|
+
|
|
+ for ( Node mojo : mojos )
|
|
+ {
|
|
+ writeGoal( sb, goalPrefix, (Element) mojo );
|
|
+ }
|
|
+
|
|
+ if ( getLog().isInfoEnabled() )
|
|
+ {
|
|
+ getLog().info( sb.toString() );
|
|
+ }
|
|
+ }
|
|
+
|
|
+
|
|
+ private static boolean isNotEmpty( String string )
|
|
+ {
|
|
+ return string != null && string.length() > 0;
|
|
+ }
|
|
+
|
|
+ private static String getValue( Node node, String elementName )
|
|
+ throws MojoExecutionException
|
|
+ {
|
|
+ return getSingleChild( node, elementName ).getTextContent();
|
|
+ }
|
|
+
|
|
+ private static Node getSingleChild( Node node, String elementName )
|
|
+ throws MojoExecutionException
|
|
+ {
|
|
+ List<Node> namedChild = findNamedChild( node, elementName );
|
|
+ if ( namedChild.isEmpty() )
|
|
+ {
|
|
+ throw new MojoExecutionException( "Could not find " + elementName + " in plugin-help.xml" );
|
|
+ }
|
|
+ if ( namedChild.size() > 1 )
|
|
+ {
|
|
+ throw new MojoExecutionException( "Multiple " + elementName + " in plugin-help.xml" );
|
|
+ }
|
|
+ return namedChild.get( 0 );
|
|
+ }
|
|
+
|
|
+ private static List<Node> findNamedChild( Node node, String elementName )
|
|
+ {
|
|
+ List<Node> result = new ArrayList<Node>();
|
|
+ NodeList childNodes = node.getChildNodes();
|
|
+ for ( int i = 0; i < childNodes.getLength(); i++ )
|
|
+ {
|
|
+ Node item = childNodes.item( i );
|
|
+ if ( elementName.equals( item.getNodeName() ) )
|
|
+ {
|
|
+ result.add( item );
|
|
+ }
|
|
+ }
|
|
+ return result;
|
|
+ }
|
|
+
|
|
+ private static Node findSingleChild( Node node, String elementName )
|
|
+ throws MojoExecutionException
|
|
+ {
|
|
+ List<Node> elementsByTagName = findNamedChild( node, elementName );
|
|
+ if ( elementsByTagName.isEmpty() )
|
|
+ {
|
|
+ return null;
|
|
+ }
|
|
+ if ( elementsByTagName.size() > 1 )
|
|
+ {
|
|
+ throw new MojoExecutionException( "Multiple " + elementName + "in plugin-help.xml" );
|
|
+ }
|
|
+ return elementsByTagName.get( 0 );
|
|
+ }
|
|
+
|
|
+ private void writeGoal( StringBuilder sb, String goalPrefix, Element mojo )
|
|
+ throws MojoExecutionException
|
|
+ {
|
|
+ String mojoGoal = getValue( mojo, "goal" );
|
|
+ Node configurationElement = findSingleChild( mojo, "configuration" );
|
|
+ Node description = findSingleChild( mojo, "description" );
|
|
+ if ( goal == null || goal.length() <= 0 || mojoGoal.equals( goal ) )
|
|
+ {
|
|
+ append( sb, goalPrefix + ":" + mojoGoal, 0 );
|
|
+ Node deprecated = findSingleChild( mojo, "deprecated" );
|
|
+ if ( ( deprecated != null ) && isNotEmpty( deprecated.getTextContent() ) )
|
|
+ {
|
|
+ append( sb, "Deprecated. " + deprecated.getTextContent(), 1 );
|
|
+ if ( detail && description != null )
|
|
+ {
|
|
+ append( sb, "", 0 );
|
|
+ append( sb, description.getTextContent(), 1 );
|
|
+ }
|
|
+ }
|
|
+ else if ( description != null )
|
|
+ {
|
|
+ append( sb, description.getTextContent(), 1 );
|
|
+ }
|
|
+ append( sb, "", 0 );
|
|
+
|
|
+ if ( detail )
|
|
+ {
|
|
+ Node parametersNode = getSingleChild( mojo, "parameters" );
|
|
+ List<Node> parameters = findNamedChild( parametersNode, "parameter" );
|
|
+ append( sb, "Available parameters:", 1 );
|
|
+ append( sb, "", 0 );
|
|
+
|
|
+ for ( Node parameter : parameters )
|
|
+ {
|
|
+ writeParameter( sb, parameter, configurationElement );
|
|
+ }
|
|
+ }
|
|
+ }
|
|
+ }
|
|
+
|
|
+ private void writeParameter( StringBuilder sb, Node parameter, Node configurationElement )
|
|
+ throws MojoExecutionException
|
|
+ {
|
|
+ String parameterName = getValue( parameter, "name" );
|
|
+ String parameterDescription = getValue( parameter, "description" );
|
|
+
|
|
+ Element fieldConfigurationElement = null;
|
|
+ if ( configurationElement != null )
|
|
+ {
|
|
+ fieldConfigurationElement = (Element) findSingleChild( configurationElement, parameterName );
|
|
+ }
|
|
+
|
|
+ String parameterDefaultValue = "";
|
|
+ if ( fieldConfigurationElement != null && fieldConfigurationElement.hasAttribute( "default-value" ) )
|
|
+ {
|
|
+ parameterDefaultValue = " (Default: " + fieldConfigurationElement.getAttribute( "default-value" ) + ")";
|
|
+ }
|
|
+ append( sb, parameterName + parameterDefaultValue, 2 );
|
|
+ Node deprecated = findSingleChild( parameter, "deprecated" );
|
|
+ if ( ( deprecated != null ) && isNotEmpty( deprecated.getTextContent() ) )
|
|
+ {
|
|
+ append( sb, "Deprecated. " + deprecated.getTextContent(), 3 );
|
|
+ append( sb, "", 0 );
|
|
+ }
|
|
+ if ( isNotEmpty( parameterDescription ) ) {
|
|
+ append( sb, parameterDescription, 3 );
|
|
+ }
|
|
+ if ( "true".equals( getValue( parameter, "required" ) ) )
|
|
+ {
|
|
+ append( sb, "Required: Yes", 3 );
|
|
+ }
|
|
+ if ( ( fieldConfigurationElement != null ) && isNotEmpty( fieldConfigurationElement.getTextContent() ) )
|
|
+ {
|
|
+ String property = getPropertyFromExpression( fieldConfigurationElement.getTextContent() );
|
|
+ append( sb, "User property: " + property, 3 );
|
|
+ }
|
|
+
|
|
+ append( sb, "", 0 );
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * <p>Repeat a String <code>n</code> times to form a new string.</p>
|
|
+ *
|
|
+ * @param str String to repeat
|
|
+ * @param repeat number of times to repeat str
|
|
+ * @return String with repeated String
|
|
+ * @throws NegativeArraySizeException if <code>repeat < 0</code>
|
|
+ * @throws NullPointerException if str is <code>null</code>
|
|
+ */
|
|
+ private static String repeat( String str, int repeat )
|
|
+ {
|
|
+ StringBuilder buffer = new StringBuilder( repeat * str.length() );
|
|
+
|
|
+ for ( int i = 0; i < repeat; i++ )
|
|
+ {
|
|
+ buffer.append( str );
|
|
+ }
|
|
+
|
|
+ return buffer.toString();
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Append a description to the buffer by respecting the indentSize and lineLength parameters.
|
|
+ * <b>Note</b>: The last character is always a new line.
|
|
+ *
|
|
+ * @param sb The buffer to append the description, not <code>null</code>.
|
|
+ * @param description The description, not <code>null</code>.
|
|
+ * @param indent The base indentation level of each line, must not be negative.
|
|
+ */
|
|
+ private void append( StringBuilder sb, String description, int indent )
|
|
+ {
|
|
+ for ( String line : toLines( description, indent, indentSize, lineLength ) )
|
|
+ {
|
|
+ sb.append( line ).append( '\n' );
|
|
+ }
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Splits the specified text into lines of convenient display length.
|
|
+ *
|
|
+ * @param text The text to split into lines, must not be <code>null</code>.
|
|
+ * @param indent The base indentation level of each line, must not be negative.
|
|
+ * @param indentSize The size of each indentation, must not be negative.
|
|
+ * @param lineLength The length of the line, must not be negative.
|
|
+ * @return The sequence of display lines, never <code>null</code>.
|
|
+ * @throws NegativeArraySizeException if <code>indent < 0</code>
|
|
+ */
|
|
+ private static List<String> toLines( String text, int indent, int indentSize, int lineLength )
|
|
+ {
|
|
+ List<String> lines = new ArrayList<String>();
|
|
+
|
|
+ String ind = repeat( "\t", indent );
|
|
+
|
|
+ String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
|
|
+
|
|
+ for ( String plainLine : plainLines )
|
|
+ {
|
|
+ toLines( lines, ind + plainLine, indentSize, lineLength );
|
|
+ }
|
|
+
|
|
+ return lines;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Adds the specified line to the output sequence, performing line wrapping if necessary.
|
|
+ *
|
|
+ * @param lines The sequence of display lines, must not be <code>null</code>.
|
|
+ * @param line The line to add, must not be <code>null</code>.
|
|
+ * @param indentSize The size of each indentation, must not be negative.
|
|
+ * @param lineLength The length of the line, must not be negative.
|
|
+ */
|
|
+ private static void toLines( List<String> lines, String line, int indentSize, int lineLength )
|
|
+ {
|
|
+ int lineIndent = getIndentLevel( line );
|
|
+ StringBuilder buf = new StringBuilder( 256 );
|
|
+
|
|
+ String[] tokens = line.split( " +" );
|
|
+
|
|
+ for ( String token : tokens )
|
|
+ {
|
|
+ if ( buf.length() > 0 )
|
|
+ {
|
|
+ if ( buf.length() + token.length() >= lineLength )
|
|
+ {
|
|
+ lines.add( buf.toString() );
|
|
+ buf.setLength( 0 );
|
|
+ buf.append( repeat( " ", lineIndent * indentSize ) );
|
|
+ }
|
|
+ else
|
|
+ {
|
|
+ buf.append( ' ' );
|
|
+ }
|
|
+ }
|
|
+
|
|
+ for ( int j = 0; j < token.length(); j++ )
|
|
+ {
|
|
+ char c = token.charAt( j );
|
|
+ if ( c == '\t' )
|
|
+ {
|
|
+ buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
|
|
+ }
|
|
+ else if ( c == '\u00A0' )
|
|
+ {
|
|
+ buf.append( ' ' );
|
|
+ }
|
|
+ else
|
|
+ {
|
|
+ buf.append( c );
|
|
+ }
|
|
+ }
|
|
+ }
|
|
+ lines.add( buf.toString() );
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Gets the indentation level of the specified line.
|
|
+ *
|
|
+ * @param line The line whose indentation level should be retrieved, must not be <code>null</code>.
|
|
+ * @return The indentation level of the line.
|
|
+ */
|
|
+ private static int getIndentLevel( String line )
|
|
+ {
|
|
+ int level = 0;
|
|
+ for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
|
|
+ {
|
|
+ level++;
|
|
+ }
|
|
+ for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
|
|
+ {
|
|
+ if ( line.charAt( i ) == '\t' )
|
|
+ {
|
|
+ level++;
|
|
+ break;
|
|
+ }
|
|
+ }
|
|
+ return level;
|
|
+ }
|
|
+
|
|
+ private static String getPropertyFromExpression( String expression )
|
|
+ {
|
|
+ if ( expression != null && expression.startsWith( "${" ) && expression.endsWith( "}" )
|
|
+ && !expression.substring( 2 ).contains( "${" ) )
|
|
+ {
|
|
+ // expression="${xxx}" -> property="xxx"
|
|
+ return expression.substring( 2, expression.length() - 1 );
|
|
+ }
|
|
+ // no property can be extracted
|
|
+ return null;
|
|
+ }
|
|
+}
|