groovy - 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. 选择要生成的源，可见性并使用标准 doclet（我建议你创建一个新文件 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