使用备用 Doclet

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

在本例中，doclet 是 UmlGraph。UmlGraph 允许 UML 类和序列图的声明性规范和绘图。有关 UmlGraph 的更多信息，请参阅http://www.spinellis.gr/sw/umlgraph/ 。

<project>
   ...
   <reporting>
      <plugins>
         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <configuration>
              <doclet>gr.spinellis.umlgraph.doclet.UmlGraph</doclet>

              <!-- <docletPath>/path/to/UmlGraph.jar</docletPath> -->
              <docletArtifact>
                <groupId>gr.spinellis</groupId>
                <artifactId>UmlGraph</artifactId>
                <version>4.4</version>
              </docletArtifact>
              <additionalparam>-views</additionalparam>
            </configuration>
         </plugin>
         ...
      </plugins>
   </reporting>
   ...
</project>

注意 ：

  • <additionalparam/> 用于在命令行上设置附加参数，专门用于 doclet 选项。
  • 如果您需要 docletpath 中的更多工件，可以使用 <docletArtifacts/>。

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

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

在 Javadoc Doclet 之外使用备用 Doclet

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

在本例中，doclet 是 Sun DocCheck。Sun Doc Check Doclet 是 Javadoc 工具的扩展。它在源代码上运行并审查文档注释，生成一个 HTML 报告，识别空注释以及文档注释中的其他遗漏和违规行为。有关 Sun DocCheck 的更多信息，请参阅http://java.sun.com/j2se/javadoc/doccheck/ 。

<project>
   ...
   <reporting>
      <plugins>
         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <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>
                  <additionalparam>
                    -d ${project.build.directory}/site/doccheck
                  </additionalparam>

                  <!-- 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>