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