Groovy 1.8的3种JavaDocs是什么?

时间:2011-06-29 18:40:43

标签: groovy groovydoc

Groovy 1.8文档有3种类型的JavaDocs:

API /   GAPI /   JDK /

jdk / Javadocs显示了Groovy添加到Java类的方法。这很容易理解。

api /和gapi /中的JavaDocs令人困惑。它们是相似的,除了api /具有不区分大小写的All Classes显示,而gapi /具有所有类的区分大小写的显示。 (区分大小写的显示器很难找到东西。)

gapi / All Classes列表在列表末尾有四个genXXX条目(再次区分大小写),它们似乎不在api / list中。

有谁知道api /和gapi / JavaDocs之间有什么区别?

感谢。

1 个答案:

答案 0 :(得分:4)

引自Paul King on the Groovy User邮件列表

  

“api”是运行javadoc的结果   跨所有Java文件。

     

“gapi”是跑步的结果   横跨所有Java和的groovydoc   Groovy文件。 (历史上这是   只是Groovy文件,但它现在运行   跨越两者。如果Groovydoc完成了   我们可以完全删除“api”但是   至少截至目前,javadoc还有更多   信息,所以我们保持两者。)

     

“groovy-jdk”正好穿过   “类别”文件   DefaultGroovyMethods而不是   报告Javadoc跨越   源文件报告它们   类别扩展的类。   E.g:

     

DGM#join(Collection self,String   分离器)

     

将报告为:

     

java.util.Collection中加入#(字符串   分离器)

     

它是如何出现的   语言用户。