Apache Maven Javadoc 插件 – 使用备用 Doclet

使用备用 Doclet

要从备用 doclet 生成输出，请将类似于以下内容的配置添加到您的 POM。

在此示例中，doclet 是 UmlGraph ( http://www.umlgraph.org/ )。UmlGraph 允许 UML 类和序列图的声明性规范和绘图。

关于 UmlGraph 的注意事项：您的 PATH 中必须有 Graphviz 二进制文件，否则将不会生成图像。有关 Graphviz 的更多信息，请参阅http://www.graphviz.org/。

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <version>3.3.2</version>
  <configuration>
    <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>
    <docletArtifact>
      <!-- UMLGraph cannot be used with Java 9 or above due to substantial changes in the JavaDoc Doclet API-->
      <groupId>org.umlgraph</groupId>
      <artifactId>umlgraph</artifactId>
      <version>5.6.6</version>
    </docletArtifact>
    <additionalparam>-views</additionalparam>
  </configuration>
</plugin>

注意：

<additionalOptions/>参数可用于在命令行上设置附加参数，特别是用于 doclet 选项。
<useStandardDocletOptions/>参数可用于指定给定的 doclet 应使用Standard Doclet 提供的选项。
如果您需要 docletpath 中的更多工件，您可以使用<docletArtifacts/>参数。

执行mvn site后，您将看到在目标目录中将生成一个 UML 图（.dot 文件）。

在 Javadoc Doclet 之外使用备用 Doclet

要从除普通 HTML Javadoc doclet 之外的备用 doclet 生成输出，请将类似于以下内容的配置添加到您的 POM。

在此示例中，doclet 是 Sun DocCheck ( http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html/ )。Sun Doc Check Doclet 是 Javadoc 工具的扩展。它在源代码上运行并审查文档注释，生成一个 HTML 报告，识别空注释以及文档注释中的其他遗漏和违规行为。

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.3.2</version>
        <reportSets>
          <reportSet>
            <id>html</id>
            <reports>
              <report>javadoc</report>
            </reports>
          </reportSet>
          <reportSet>
            <id>doccheck</id>
            <configuration>
              <doclet>com.sun.tools.doclets.doccheck.DocCheck</doclet>

              <!-- <docletPath>/path/to/doccheck.jar</docletPath> -->
              <docletArtifact>
                <groupId>com.sun.tools.doclets</groupId>
                <artifactId>doccheck</artifactId>
                <version>1.2b2</version>
              </docletArtifact>
              <additionalOptions>
                <additionalOption>-d</additionalOption>
                <additionalOption>${project.build.directory}/site/doccheck</additionalOption>
              </additionalOptions>

              <!-- Other dir than apidocs -->
              <destDir>doccheck</destDir>

              <!-- For the project-reports page-->
              <name>DocCheck</name>
              <description>DocCheck documentation.</description>
            </configuration>
            <reports>
              <report>javadoc</report>
            </reports>
          </reportSet>
        </reportSets>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>