要从备用 doclet 生成输出,请将类似于以下内容的配置添加到您的 POM。
在此示例中,doclet 是 UmlGraph ( http://www.umlgraph.org/ )。UmlGraph 允许 UML 类和序列图的声明性规范和绘图。
关于 UmlGraph 的注意事项:您的 PATH 中必须有 Graphviz 二进制文件,否则将不会生成图像。有关 Graphviz 的更多信息,请参阅http://www.graphviz.org/。
<project> ... <reporting> (or <build>) <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.6.1</version> <configuration> <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet> <!-- <docletPath>/path/to/UmlGraph.jar</docletPath> --> <docletArtifact> <groupId>org.umlgraph</groupId> <artifactId>doclet</artifactId> <version>5.1</version> </docletArtifact> <additionalparam>-views</additionalparam> <useStandardDocletOptions>true</useStandardDocletOptions> </configuration> </plugin> ... </plugins> </reporting> (or </build>) ... </project>
注意:
执行mvn site后,您将看到在目标目录中将生成一个 UML 图(.dot 文件)。
要从除普通 HTML Javadoc doclet 之外的备用 doclet 生成输出,请将类似于以下内容的配置添加到您的 POM。
在此示例中,doclet 是 Sun DocCheck ( http://java.sun.com/j2se/javadoc/doccheck/ )。Sun Doc Check Doclet 是 Javadoc 工具的扩展。它在源代码上运行并审查文档注释,生成一个 HTML 报告,识别空注释以及文档注释中的其他遗漏和违规行为。
<project> ... <reporting> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.6.1</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> <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>