Doclets vs DocLava



我的理解是:

  • Java Doclet API 只是一个植根于 com.sun.javadoc
  • 当Javadoc运行时,它会在运行时查找要绑定到的Doclet API impl
  • 如果不存在这样的 impl,那么它使用一些默认值(因此您可以生成 Javadocs 而无需指定自己的 CSS 文件等(。
  • Google的DocLava就是这样一个Doclet API impl

如果这是真的,那么如何在默认值上指定不同的 Doclet impl(例如 DocLava(?如果我离基础很远,那么Javadoc工具,Doclet API和DocLava如何相互关联?

如何在默认值上指定不同的 Doclet impl(例如 DocLava(?

请参阅 javadoc 工具文档命令行选项部分。 指定要与 -doclet 参数一起使用的文档:

-doclet class

指定启动用于生成文档的文档的类文件。使用完全限定的名称。此文档定义内容并设置输出格式。如果未使用 -doclet 选项,javadoc 将使用标准 doclet 来生成默认的 HTML 格式。此类必须包含 start(Root( 方法。此起始类的路径由 -docletpath 选项定义。

例如,要调用 MIF 文档,请使用:

   -doclet com.sun.tools.doclets.mif.MIFDoclet

有关运行特定文档的完整工作示例,请参阅运行 MIF 文档。

有关使用 DocLava 文档的详细信息,请参阅 DocLava 入门指南:

传递给 Javadoc 以使用 Doclava 的命令行参数是:

-doclet com.google.doclava.Doclava
-docletpath ${jar.file}

相关内容

  • 没有找到相关文章

最新更新