Groovydoc производит чистые документы

Question

Я пишу класс в Groovy, и я хочу создать Groovydoc для него (из командной строки). В моем классе я написал документацию для таких методов:

/**
 * Returns blah blah blah
*/
def getFoo(){
    ...
}

Но когда я бегу groovydoc -classpath C:\groovyStuff\ -d . *.groovy

Он генерирует шаблон HTML, но без фактического содержания.

Что я сделал не так?

Answer 1

Если корень вашего исходного дерева c:\groovyStuff\ Вы можете использовать что-то вроде этого...

groovydoc -sourcepath c:\groovyStuff -d . com.somepackage

-d . немного странно, потому что это помещает сгенерированные файлы в текущий каталог. Это то, что вы использовали в своем примере, но, возможно, вы хотите что-то вроде -d output или что-то подобное.

Это помогает?

Answer 2

Для пользователей Eclipse есть обходной путь:

1. Перейти к проекту -> Создать Javadoc...
2. В команде Javadoc замените путь "javadoc.exe" на путь "groovydoc.bat".
3. Выберите источники, которые будут созданы, видимость и используйте стандартный доклет (я предлагаю вам создать новый файл src / main / groovydoc и удалить src/main/javadoc)

Answer 3

Если ваше приложение состоит из файлов Java и Groovy, вы можете использовать следующий сценарий bash, в котором перечислены все файлы java и groovy в исходном каталоге (даже пропуская нежелательные).

source_files=`find {path-to-your-dir}/ -type f \( \
    \( \
    -name "*.java" \
    -or -name "*.groovy" \
    \) \
    ! \
    \( \
     -name "UndesiredOne.java" \
     -or -name "UndesiredTwo.groovy" \
    \) \
    \)`

groovydoc -verbose --debug -public\
 -d {path-to-your-doc-dir}\
 -doctitle "Title"\
 -header "Header"\
 -footer "Footer"\
 -windowtitle "WindowTitle"\
 $source_files