logo Apache Maven Javadoc Plugin

The Apache Maven Javadoc Plugin is a plugin that uses the javadoc tool for generating javadocs for the specified project.

homepage: maven.apache.org/plugins
fresh index:
last release: 4 months ago, first release: 2 decades ago
packaging: maven-plugin
get this artifact from: atlassian-3rd-party central
see this artifact on: search.maven.org


Display vulnerabilities (snyk): Vulnerability check

This chart shows how much is this artifact used as a dependency in other Maven artifacts in Central repository and GitHub:


select version:

Add this snippet into pom.xml inside tag <project><build><plugins>:




Switch to artifact.
goals:
javadoc:aggregate

Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool. Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project.

javadoc:aggregate-jar (phase: package)

Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool. Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.

javadoc:aggregate-no-fork

Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.

javadoc:fix

Fix Javadoc documentation and tags for the Java code for the project. See Where Tags Can Be Used.

javadoc:help

Display help information on maven-javadoc-plugin. Call mvn javadoc:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

javadoc:jar (phase: package)

Bundles the Javadoc documentation for main Java code in an NON aggregator project into a jar using the standard Javadoc Tool.

javadoc:javadoc

Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool.

javadoc:javadoc-no-fork

Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of sources before site generation, e.g. by invoking mvn clean deploy site.

javadoc:resource-bundle (phase: package)

Bundle {@link AbstractJavadocMojo#javadocDirectory}, along with javadoc configuration options such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.

javadoc:test-aggregate

Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool. Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project.

javadoc:test-aggregate-jar (phase: package)

Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool. Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.

javadoc:test-aggregate-no-fork

Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool.

javadoc:test-fix

Fix Javadoc documentation and tags for the Test Java code for the project. See Where Tags Can Be Used.

javadoc:test-jar (phase: package)

Bundles the Javadoc documentation for test Java code in an NON aggregator project into a jar using the standard Javadoc Tool.

javadoc:test-javadoc

Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool.

javadoc:test-javadoc-no-fork

Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking mvn clean deploy site.

javadoc:test-resource-bundle (phase: package)

Bundle {@link TestJavadocJar#testJavadocDirectory}, along with javadoc configuration options from {@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.

Often used code snippets:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <version>3.1.1</version>
  <executions>
    <execution>
      <id>attach-javadocs</id>
      <goals>
        <goal>jar</goal>
      </goals>
    </execution>
  </executions>
  <configuration>
    <failOnError>false</failOnError>
    <show>protected</show>
    <sourceFileExcludes>
      <exclude>**/$Module.java</exclude>
    </sourceFileExcludes>
    <additionalJOption>-J-XX:+TieredCompilation</additionalJOption>
    <additionalJOption>-J-XX:TieredStopAtLevel=1</additionalJOption>
  </configuration>
</plugin>
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <version>2.9.1</version>
  <executions>
    <execution>
      <id>attach-javadocs</id>
      <goals>
        <goal>jar</goal>
      </goals>
    </execution>
  </executions>
</plugin>
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <version>3.0.1</version>
  <executions>
    <execution>
      <id>attach-javadocs</id>
      <goals>
        <goal>jar</goal>
      </goals>
    </execution>
  </executions>
  <configuration>
    <failOnError>false</failOnError>
    <show>protected</show>
    <sourceFileExcludes>
      <exclude>**/$Module.java</exclude>
    </sourceFileExcludes>
    <additionalJOption>-J-XX:+TieredCompilation</additionalJOption>
    <additionalJOption>-J-XX:TieredStopAtLevel=1</additionalJOption>
  </configuration>
</plugin>
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <executions>
    <execution>
      <id>attach-javadocs</id>
      <goals>
        <goal>jar</goal>
      </goals>
    </execution>
  </executions>
</plugin>
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <version>3.0.1</version>
  <executions>
    <execution>
      <id>attach-javadocs</id>
      <goals>
        <goal>jar</goal>
      </goals>
    </execution>
  </executions>
  <configuration>
    <failOnError>false</failOnError>
    <show>protected</show>
  </configuration>
</plugin>

© Jiri Pinkas 2015 - 2022. All rights reserved! Admin login To submit bugs / feature requests please use this github page
related: JavaVids | Top Java Blogs | Java školení
Apache and Apache Maven are trademarks of the Apache Software Foundation. The Central Repository is a service mark of Sonatype, Inc.