如何从詹金斯全球图书馆生成Groovydoc

Question

我有一个詹金斯全球图书馆，我想记录下来。我想使用groovydoc。

该库包含类和全局变量

src/<package-name>
vars

生成类的文档没有问题：

groovydoc -sourcepath src -d doc 'main.pipeline' '*.groovy'

但是，如何生成有关var的文档？

Answer 1

今天在工作中遇到了同样的问题，遗憾的是现在无法尝试我的解决方案，但请尝试使用同时包含src和varsas 的目录sourcepath。然后您可以在命令中引用您的目录src和子目录，如下所示：vars

groovydoc -sourcepath [PATH_TO_YOUR_LIB] -d doc src\ vars\

如果这不起作用，请尝试分别引用每个包，如下所示：

groovydoc -sourcepath [PATH_TO_YOUR_LIB] -d doc src\org.foo.some_package src\org.foo.some_other_package vars\

或者，或者作为解决方法，您可以使用 IntelliJ IDE 及其“生成 GroovyDoc...”工具：

1. 启动 IntelliJ 并打开任何 Groovy 项目（如果没有现有项目，则创建一个新项目）
2. 从菜单栏Tools > Generate GroovyDoc...
3. 选择包含 jenkins 管道库的源路径Input directory（包含src和vars）以及任何路径Output directory
4. 按Start
5. GroovyDoc 应该在指定的Output directory