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. 转到项目 - ＆gt;生成Javadoc ......
2. 在Javadoc命令中，替换＆＃39; javadoc.exe＆＃39;使用＆＃39; groovydoc.bat＆＃39;路径。
3. 选择要生成的源，可见性并使用标准doclet（我建议您创建一个新文件src / main / groovydoc并删除src / main / javadoc）

Answer 3

如果您的应用程序包含Java和Groovy文件，则可以利用下一个bash脚本，该脚本列出源目录中的所有Java和Groovy文件（甚至跳过不需要的文件）

# Any route containing a file extension (e.g. /devicesfile.js)
location ~ ^.+\..+$ {
    try_files $uri =404;
}