2011-06-29 7 views
6

Groovy 1.8 docs mają 3 rodzaje Javadocs:Jakie są 3 typy JavaDocs dla Groovy 1.8?

api/ GAPI/ jdk/

JDK/Javadocs metody pokazują, że Groovy dodaje do klas Javy. Łatwo to zrozumieć.

JavaDocs w api/i gapi/są mylące. Są one podobne, z tym wyjątkiem, że api/ma rozróżnianie wielkości liter we wszystkich klasach, podczas gdy gapi/ma rozróżnianie wielkości liter we wszystkich klasach. (Rozróżnianie wielkości liter sprawia, że ​​trudno jest znaleźć rzeczy.)

Lista gapi/Wszystkie klasy zawiera cztery pozycje genXXX na końcu listy (sortowanie z rozróżnianiem wielkości liter), które prawdopodobnie nie znajdują się na liście api/lista.

Czy ktoś wie, jaka jest różnica między api/i gapi/JavaDocs?

Dzięki.

Odpowiedz

3

Cytat z listy Paul King on the Groovy User korespondencji

"API" jest wynikiem prowadzenia javadoc we wszystkich plików Java.

"gapi" jest wynikiem działania groovydoc na wszystkie pliki Java i Groovy. (Historycznie było to tylko tylko pliki Groovy, ale teraz działa na obu.Jeśli Groovydoc został zakończony możemy usunąć "api" łącznie ale co najmniej od teraz, javadoc ma więcej informacji w nim, więc trzymamy obie.)

„Groovy-jdk” jest natknąć tylko pliki „kategoria” jak DefaultGroovyMethods i zamiast zgłoszenie Javadoc w całym pliku źródłowym zgłasza je w poprzek klas którego kategoria rozciąga. Np

DGM # przyłączyć (Self Collection, String separator)

będą zgłaszane jako:

java.util.Collection # join (String separator)

który jest jak wydaje się użytkownikowi języka .

+1

Ugh. Potrzebujemy jednego zestawu dokumentów, który jest wyczerpujący. Szczelina GroovyDoc powinna być najlepsza, ale ten problem jest zależny od wielkości liter. –

Powiązane problemy