问题标签 [groovydoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
4 回答
3104 浏览

maven-2 - GroovyDoc 作为 Maven 插件

在某处是否有可用的 Maven 插件GroovyDoc,最好是作为报告?

我猜GMaven会是查看的地方,但文档是古老的(1.0,而当前版本是 1.3)并且 GMaven 插件没有任何适合您的魔力,如您所见:

这个插件有 9 个目标:

groovy:compile
描述:编译 Groovy 源代码。

groovy:console
描述:启动 Groovy GUI 控制台。

groovy:execute
描述:执行 Groovy 脚本。

groovy:generateStubs
描述:从 Groovy 源代码生成 Java 存根。

groovy:generateTestStubs
描述:从 Groovy 测试源生成 Java 存根。

groovy:help
描述:显示 gmaven-plugin 的帮助信息。
调用
mvn groovy:help -Ddetail=true -Dgoal=<goal-name>
以显示参数详细信息。

groovy:providers
描述:显示有关已配置和选择的 Groovy 运行时提供程序的信息。

groovy:shell
描述:启动 Groovy Shell(又名 groovysh)。

groovy:testCompile
描述:编译 Groovy 测试源。

那么有没有人有任何指向 maven groovydoc 插件的指针?谷歌没有想出任何有意义的东西。

0 投票
1 回答
1038 浏览

groovy - Groovy 1.8 的 3 种 JavaDocs 是什么?

Groovy 1.8 文档有 3 种 JavaDocs:

api/gapi/jdk/

jdk/Javadocs 展示了 Groovy 添加到 Java 类的方法。这很容易理解。

api/ 和 gapi/ 中的 JavaDocs 令人困惑。它们是相似的,只是 api/ 具有所有类的不区分大小写显示,而 gapi/ 具有所有类的区分大小写显示。(区分大小写的显示让人很难找到东西。)

gapi/ 所有类列表在列表末尾有四个 genXXX 条目(再次区分大小写排序),它们似乎不在 api/ 列表中。

有谁知道 api/ 和 gapi/ JavaDocs 之间有什么区别?

谢谢。

0 投票
2 回答
434 浏览

grails - grails-doc 在默认包中创建我的类的副本

在我的 grails 1.3.7 项目中,我已经将我的所有类都放在了 com.mycompany.myapp 中,就像你一样。所以这适用于服务、控制器、域类。我有一个自带包装的过滤器。我的应用程序运行良好。

但是,当我运行时grails doc,grails 决定为每个类创建两个页面:

  • 一个在其正确的 comp.mycompany.myapp 包中具有所有正确的 Groovy Doc
  • 另一个采用上述所有类并假装这些类也存在于默认包中。

因此,target/docs 包含两个目录:“DefaultPackage”和“com”,其中 DefaultPackage 保存了 com/ 下所有内容的副本

因此,我的 groovy 文档看起来很乱,因为每个类都有两个副本。

我该如何解决这个问题?

0 投票
1 回答
1574 浏览

grails - 如何在 IntelliJ IDEA Grails 项目中为 groovy 方法获取 javadocs / groovydocs?

在 Grails 项目中工作时,对于 groovy 添加到集合之类的东西的 GDK 方法,我没有得到任何有用的 javadocs / groovydocs。有没有办法做到这一点,或者这是 IntelliJ IDEA 无法做到的?

0 投票
1 回答
696 浏览

maven - 使用 maven 从 groovydoc 生成 jar 文件

是否有某种方法可以从 Maven 内部生成的 groovydoc 生成要在 IDE(如 IDEA、Eclipse 等)中使用的 jar 文件?我目前正在使用此处描述的 maven antrun 插件从一个相当大的 groovy 项目生成 groovydoc:GroovyDoc as Maven Plugin

我能够通过手动将输出文件打包到存档中来获得可用的 jar 文件,但我正在寻找一种集成方式(即使用 maven),它还允许我将这些文件部署到存储库。

0 投票
2 回答
1546 浏览

gradle - 如何在 Gradle 中为 Groovydoc 设置字符编码?

我有带有 UTF-8 编码的 Groovy 代码,并且需要生成的 Groovydoc HTML 才能使用相同的代码。但是如何在 Gradle 中配置呢?

0 投票
1 回答
1234 浏览

groovy - 本地包链接的 groovydoc

在我的 groovy 文件中,我有一个 groovydoc 链接,如下所示:

因为 的类myMethod与 相同的包MyClassInSamePackage,所以这应该可以工作,但它不会在文档中生成链接,而是在<code>标签中将其包围。我最近打开了https://issues.apache.org/jira/browse/GROOVY-5957,但根据https://issues.apache.org/jira/browse/GROOVY-3745,看起来这个问题应该是已修复(我使用的是 groovy 2.0.5)。

如果不使用完整的包名,任何人都可以确认(或反驳)同一包中的链接是否在 groovydoc 中正常工作?

0 投票
0 回答
471 浏览

maven - 如何让 GroovyDoc 正确记录具有泛型类型参数的返回类型?

我有一个 ant 任务,它生成在我的 Maven pom 文件中定义的 GroovyDoc。除了返回如下内容的方法的方法文档之外,一切看起来都很棒:

这就是我定义任务的方式:

0 投票
1 回答
755 浏览

gradle - Gradle 中的 GroovyDoc 不起作用

我正在尝试使用命令在 gradle 脚本中生成 groovydocs gradle groovydoc。我可以看到成功执行的命令如下:

但我没有看到文件系统中生成任何 API。我在这里想念什么?

0 投票
0 回答
68 浏览

groovy - groovydoc 可以处理自动生成的 get/set 方法吗?

我有一个用 groovy 编写的库,我想让 Java 用户可以使用它。但是,当我使用 groovydoc 生成文档时,它不包含任何用于我的类属性的 get/set 方法。有没有办法让它产生它?