Apache Maven Javadoc Plugin – Configuring Custom Taglets

Configuring Custom Taglets

You could configure any custom taglets in your Javadoc Plugin configuration via the <taglet/>, <taglets/>, or <tagletArtifacts/> parameters, depending the number of taglets used.

For more information about the taglet technology, please refer to http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/overview.html.

One Taglet

For one known Taglet, just use the <taglet/> parameter:

<project>
  ...
  <reporting> (or <build>)
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.7.0</version>
        <configuration>
          ...
          <taglet>package.to.YourTagletClass</taglet>
          <!-- <tagletpath>/path/to/taglet.jar</tagletpath> -->
          <tagletArtifact>
            <groupId>group-Taglet</groupId>
            <artifactId>artifact-Taglet</artifactId>
            <version>version-Taglet</version>
          </tagletArtifact>
          ...
        </configuration>
      </plugin>
    </plugins>
    ...
  </reporting> (or </build>)
  ...
</project>

Several Taglets

For several known Taglets, just use the <taglets/> parameter:

<project>
  ...
  <reporting> (or <build>)
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.7.0</version>
        <configuration>
          ...
          <taglets>
            <taglet>
              <tagletClass>package.to.YourFirstTagletClass</tagletClass>
              <!-- <tagletpath>/path/to/taglet.jar</tagletpath> -->
              <tagletArtifact>
                <groupId>group-FirstTaglet</groupId>
                <artifactId>artifact-FirstTaglet</artifactId>
                <version>version-FirstTaglet</version>
              </tagletArtifact>
            </taglet>

            <taglet>
              <tagletClass>package.to.YourSecondTagletClass</tagletClass>
              <!-- <tagletpath>/path/to/taglet.jar</tagletpath> -->
              <tagletArtifact>
                <groupId>group-SecondTaglet</groupId>
                <artifactId>artifact-SecondTaglet</artifactId>
                <version>version-SecondTaglet</version>
              </tagletArtifact>
            </taglet>
            ...
          </taglets>
          ...
        </configuration>
      </plugin>
    </plugins>
    ...
  </reporting> (or </build>)
  ...
</project>

If it is several Taglets in the same Taglet artifact, you could use the <taglets/> and the <tagletArtifact/> parameters:

<project>
  ...
  <reporting> (or <build>)
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.7.0</version>
        <configuration>
          ...
          <taglets>
            <taglet>
              <tagletClass>package.to.YourFirstTagletClass</tagletClass>
            </taglet>

            <taglet>
              <tagletClass>package.to.YourSecondTagletClass</tagletClass>
            </taglet>
            ...
          </taglets>

          <tagletArtifact>
            <groupId>group-Taglet</groupId>
            <artifactId>artifact-Taglet</artifactId>
            <version>version-Taglet</version>
          </tagletArtifact>
          ...
        </configuration>
      </plugin>
    </plugins>
    ...
  </reporting> (or </build>)
  ...
</project>

If you don't know the Taglets or if you want to auto-detect Taglet class names, you could use the <tagletArtifacts/> parameter:

<project>
  ...
  <reporting> (or <build>)
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.7.0</version>
        <configuration>
          ...
          <tagletArtifacts>
            <tagletArtifact>
              <groupId>group-FirstTaglet</groupId>
              <artifactId>artifact-FirstTaglet</artifactId>
              <version>version-FirstTaglet</version>
            </tagletArtifact>

            <tagletArtifact>
              <groupId>group-SecondTaglet</groupId>
              <artifactId>artifact-SecondTaglet</artifactId>
              <version>version-SecondTaglet</version>
            </tagletArtifact>
            ...
          </tagletArtifacts>
          ...
        </configuration>
      </plugin>
    </plugins>
    ...
  </reporting> (or </build>)
  ...
</project>