What are the 3 types of JavaDocs for Groovy 1.8?

Question

There are 3 types of JavaDocs in Groovy 1.8 docs:

API / GAPI / JDK /

Jdk / Javadocs displays the methods that Groovy adds to Java classes. This is easy to understand.

JavaDocs in api / and gapi / are confusing. They are similar, except that api / has a case-insensitive display of all classes, while gapi / has a case-sensitive display of all classes. (A case-sensitive display makes finding things difficult.)

In the gapi / All Classes list, there are four genXXX entries at the end of the list (this case-sensitive register) that do not seem to be in the api / list.

Does anyone know what is the difference between api / and gapi / JavaDocs?

Thanks.

Answer 1

Quote from Paul King on the Groovy mailing list

"api" is the result of running javadoc through all Java files.

"gapi" is the result of groovydoc running across Java and Groovy. (Historically, these were only Groovy files, but now they run on both. If Groovydoc was finished we could remove the “api” altogether, but at least for now, javadoc has more information in it, so we save both.)

"groovy -jdk" is executed through Files in the DefaultGroovyMethods category and instead of reporting Javadok through the source file, it reports this through the classes to which the category applies. For instance:.

DGM # join (Collection self, String separator)

will display as:

java.util.Collection # join (String separator)

how this is represented by the user's language.