• Home
  • Docker
  • Kubernetes
  • LLMs
  • Java
  • Ubuntu
  • Maven
  • Big Data
  • Archived
Maven | maven-javadoc-plugin
  1. Maven Javadoc Plugin (3.4.1)
  2. The goal help
  3. Example: Using javadoc plugin

  1. Maven Javadoc Plugin (3.4.1)
    Uses the javadoc tool for generating javadocs for the specified project.

    Plugin coordinates:
    • Group Id: org.apache.maven.plugins
    • Artifact Id: maven-javadoc-plugin

    Plugin Prefix: javadoc

    The javadoc plugin has the following goals:
    • help: Display help information on maven-javadoc-plugin.

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

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

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

    • test-javadoc: Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool.

    • 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.

    • 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.

    • aggregate-jar: Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.

    • test-aggregate-jar: Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.

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

    • test-aggregate: Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool.

    • aggregate-no-fork: Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.

    • test-aggregate-no-fork: Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool.

    • resource-bundle: Bundle AbstractJavadocMojo.javadocDirectory, along with javadoc configuration options.

    • test-resource-bundle: Bundle TestJavadocJar.testJavadocDirectory, along with javadoc configuration options.

    • fix: Fix Javadoc documentation and tags for the Java code for the project.

    • test-fix: Fix Javadoc documentation and tags for the Test Java code for the project.
  2. The goal help
    The goal help gives general information about the javadoc plugin and lists its goals.
    The parameter detail gives detailed information about the parameters of the goals of the javadoc plugin.

    If you need to use the plugin's coordinates instead of its prefix, you can do that as following:

    You can also use the goal describe of the help plugin to get information about the javadoc plugin and lists its goals:

    The parameter goal gives information about a goal of the javadoc plugin:
  3. Example: Using javadoc plugin
    Adjust your pom file with the following:
© 2025  mtitek