Groovydoc 生成空白文档答案

【问题标题】：Groovydoc produces blank documentsGroovydoc 生成空白文档
【发布时间】：2014-07-08 17:34:05
【问题描述】：

我正在用 Groovy 编写一个类，我想为它生成 Groovydoc（从命令行）。在我的课堂上，我为这样的方法编写了文档：

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

但是当我运行groovydoc -classpath C:\groovyStuff\ -d . *.groovy

它生成 HTML 模板，但没有实际内容。

我做错了什么？

【问题讨论】：

运行命令时*.groovy文件在当前目录吗？
不，它们在 groovyStuff 目录中。我正在尝试对 *.groovy 文件运行命令

标签： groovy javadoc groovydoc

【解决方案1】：

如果你的源代码树的根是c:\groovyStuff\，你可以使用这样的东西......

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

-d . 有点奇怪，因为它会将生成的文件放在当前目录中。这就是您在示例中使用的内容，但也许您想要-d output 或类似的内容。

这有帮助吗？

【讨论】：

源路径还是类路径？我以marxsoftware.blogspot.com/2011/05/… 为例。示例命令位于页面中间。我也不觉得文件需要成为包的一部分。
sourcepath 和 classpath 是两个不同的东西。我的意思是 sourcepath，这是我输入的。例如，如果您有 c:\groovyStuff\com\somepackage\Demo.groovy 和 c:\groovyStuff\com\somepackage\Widget.groovy 之类的文件，我上面显示的命令将为当前目录（无论您从哪个目录执行该命令）中的文件生成 javadocs。
您可能需要也可能不需要指定类路径。这取决于问题中未表示的代码的详细信息。
好的，它适用于源路径。我必须指定类的名称，但 *.groovy 不起作用。谢谢您的帮助！ groovydoc -sourcepath C:\groovyStuff -d 。 scriptName.groovy

【解决方案2】：

对于 Eclipse 用户，这里有一个解决方法：

转到项目 -> 生成 Javadoc...
在 Javadoc 命令中，将“javadoc.exe”路径替换为“groovydoc.bat”路径。
选择要生成的源，可见性，使用标准的doclet（我建议你新建一个文件src/main/groovydoc，删除src/main/javadoc）

【讨论】：

【解决方案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

【讨论】：