问题标签 [groovydoc]

我在使用GroovyDocTool时遇到了困难。

无论我传入什么路径，我rootDoc都不会解析为任何包、类或方法。我不得不假设我只是在错误的道路上经过，但对于我的生活来说，我无法弄清楚要经过什么。

什么被认为是传递给的有效参数GroovyRootDocBuilder？

如果我有一个项目，其中应用了java、groovy和kotlin插件，并且每个插件都编写了代码，我该如何创建（并且应该）创建一个javadoc.jar包含所有代码文档的单一发行版？

java插件给了我javadoc课程，插件groovy给了我groovydoc任务，但这些似乎并不配合。

我如何将这个文档“合并”成一个单一的有凝聚力的工件？

我使用了Tools -> Generate Groovydoc...没有任何问题，但现在它停止工作了。如果我创建新项目，我没有这个选项。我可以以某种方式查看有关文档生成的日志吗？我不知道从哪里开始调查。

我试图清理，重建我的项目，但没有帮助。谢谢！

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

该库包含类和全局变量

为类生成文档没有问题：

但是如何为 vars 生成文档呢？

例如，我有以下代码UserController.groovy：

...当由 Gradle 的groovydoc任务生成时，会产生以下内容：

但是，我希望groovydoc任务能够解析方法注释并像Spring 的 API 文档一样显示它们：

有没有办法配置groovydocGradle 任务来做到这一点，还是我需要使用另一个库或工具？

我试图关注这篇文章 如何在 Eclipse 中生成 Javadoc HTML？ 但是在我的 Eclipse Neon 3 或 Mars 2 版本中，我看不到像 Project --> Generate JavaDocs 这样的菜单选项...我需要安装任何插件还是做一些准备步骤？

我正在尝试从一些 groovy 代码生成文档，但 Gradle 失败，因为它在尝试编译代码时无法导入依赖项。这是意料之中的，因为在这些依赖项可用之前，代码需要在特定的上下文中运行。我不知道为什么它似乎应该只是解析源代码以提取文档，但它甚至试图编译代码，但这是一个附带问题。

我的 build.gradle：

我已经尝试了各种方法，例如exclude在groovyCompile和CompileGroovy任务中，但这没有任何区别。我无法在这种情况下提供依赖项。欢迎提出其他建议。任何能够确定使用 asciidoc 记录 groovy 的可行解决方案的人都可以获得奖励积分，但我也未能实现。

我正在尝试使用 GroovyRootDocBuilder 获取类文档

我只得到类文档和构造函数文档，我无法检索方法和字段文档的任何信息。

我正在尝试使用 Intellij (2109.3.3) 为 Groovy 库创建文档，并使用 Gradle 窗口中的 groovydoc 任务进行 Gradle 构建。

库的结构如下：

使用的组件 (AnyGroupOfPipelineCollects) 只是一个示例，因为 {@link } 标记在我创建的任何文档中都不起作用。

课程开始如下：

执行 Gradle groovydoc 任务后，构建的文档如下：

AnyGroupOfPipelineCollects 包含一组并行发生的网络，每个管道包含阶段Worker 进程，不包括最终的 GPP_Library.terminals.Collect 阶段。假设来自上述过程的输入来自通道的任何一端。在内部，创建了一组GPP_Library.functionals.pipelines.OnePipelineCollect 管道。

可以看出，链接到 Collect 和 OnePipelineCollect 作为超文本项的预期转换并未发生，即使 {@code} 标记已被正确处理。

此外，作为链接 package.class 元素的一种类型，Intellij 会识别不正确的公式，直到它们正确为止。

我意识到库的名称不符合 Java 命名约定，因此将其更改为不同的名称，但这对生成的文档没有影响。

在 Groovy 中是否有标准的方法来记录地图属性？

对于以下功能，配置包含多个可选属性，例如：

• ignore
• dir
• tags

我查看了使用 JavaDoc 记录地图的标准方法是什么？; 但是，这不适用于动态地图。理想情况下，我正在寻找类似 JSDoc@typedef或@property.