Какие 3 типа JavaDocs для Groovy 1.8? - PullRequest
Новая
       22

Какие 3 типа JavaDocs для Groovy 1.8?

7 голосов
/ 29 июня 2011

Документы Groovy 1.8 имеют 3 типа JavaDoc:

api / gapi / jdk /

В jdk / Javadocs показаны методы, которые Groovy добавляет в классы Java.Это легко понять.

JavaDocs в api / и gapi / сбивают с толку.Они похожи, за исключением того, что api / имеет регистрозависимое отображение всех классов, а gapi / регистрозависимое отображение всех классов.(Чувствительный к регистру дисплей затрудняет поиск вещей.)

В списке gapi / All Classes есть четыре записи genXXX в конце списка (опять же, с учетом регистра), которые, похоже, не соответствуютбыть в api / list.

Кто-нибудь знает, в чем разница между api / и gapi / JavaDocs?

Спасибо.

1 Ответ

4 голосов
/ 29 июня 2011

Цитируется из Пол Кинг в Groovy User список рассылки

"api" - это результат запуска javadoc во всех файлах Java.

"Гапи" - результат бега groovydoc по всей Java и Groovy файлы. (Исторически это было только файлы Groovy, но теперь он работает через оба. Если Groovydoc был закончен мы могли бы удалить «API» в целом, но по крайней мере, на данный момент, Javadoc имеет больше информация в нем, поэтому мы держим оба.)

"groovy-jdk" запускается только через файлы категории DefaultGroovyMethods и вместо сообщая Javadoc через исходный файл сообщает о них через классы, которые расширяет категория. E.g.:

DGM # join (Коллекция self, String сепаратор)

будет сообщено как:

java.util.Collection # присоединиться (String сепаратор)

как это выглядит пользователь языка.

...