Doclets与DocLava

时间:2012-05-15 22:07:13

标签: java javadoc doclet

我的理解是:

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

如果这是真的,那么如何在默认情况下指定不同的Doclet impl(例如DocLava)?如果我离开基地,那么Javadoc工具,Doclet API和DocLava如何相互关联?

1 个答案:

答案 0 :(得分:4)

  

如何在默认情况下指定不同的Doclet impl(例如DocLava)?

请参阅javadoc tool documentation命令行选项部分。您可以指定要与-doclet参数一起使用的文档:

  

-doclet class

     

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

     

例如,要调用MIF doclet,请使用:

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

有关运行特定doclet的完整实用示例,请参阅Running the MIF Doclet

有关使用DocLava doclet的详细信息,请参阅DocLava Getting Started指南:

  

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

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