2011-06-29 13 views
6

Los maravillosos 1,8 docs tienen 3 tipos de JavaDocs:¿Cuáles son los 3 tipos de JavaDocs para Groovy 1.8?

API/ gapi/ JDK/

el JDK/javadocs métodos muestran que Groovy se suma a las clases de Java. Eso es fácil de entender.

Los JavaDocs en api/y gapi/son confusos. Son similares, excepto que api/tiene una visualización insensible a mayúsculas/minúsculas de todas las clases, mientras que gapi/tiene una visualización de mayúsculas y minúsculas de todas las clases. (La pantalla sensible a las mayúsculas hace que sea difícil encontrar cosas.)

La lista gapi/Todas las clases tiene cuatro entradas genXXX al final de la lista (esa clasificación sensible a mayúsculas de nuevo) que no parece estar en la api/lista.

¿Alguien sabe cuál es la diferencia entre la API/y gapi/JavaDocs?

Gracias.

Respuesta

3

Citado de la lista de correo Paul King on the Groovy User

"API" es el resultado de ejecutar javadoc a través de todos los archivos de Java.

"gapi" es el resultado de ejecutar groovydoc en todos los archivos de Java y Groovy. (Históricamente, esta era sólo los archivos maravillosos pero ahora dirige través de ambos. Si Groovydoc se terminó pudiéramos eliminar "API" por completo, pero al menos a partir de ahora, javadoc tiene más información en ella por lo que mantenemos ambos.)

"groovy-jdk" se ejecuta a través de sólo los archivos "categoría" como DefaultGroovyMethods y en lugar de informar el Javadoc a través del archivo de origen les informa a través de las cuales se extiende clases de la categoría. Ej:

DGM # join (auto Collection, Cadena separador)

será reportado como:

java.util.Collection # unen (String separador)

que es como aparece para el usuario de lenguaje .

+1

Ugh. Necesitamos un conjunto de documentos que sea completo. El GroovyDoc gapi debería ser el mejor, pero la visualización de mayúsculas y minúsculas es un problema. –

Cuestiones relacionadas