在Grails项目中工作时,我没有为GDK方法获得任何有用的javadocs/groovydocs,groovy添加到集合之类的东西.有没有办法做到这一点,或者这是IntelliJ IDEA不能做的事情?
是否有可以使用的maven插件GroovyDoc
,最好是作为报告使用?
我猜GMaven是一个值得一看的地方,但是文档是古老的(1.0,而当前版本是1.3),GMaven插件没有任何适合你的mojo:
mvn help:describe -DgroupId=org.codehaus.gmaven -DartifactId=gmaven-plugin
Run Code Online (Sandbox Code Playgroud)
这个插件有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插件的指针?谷歌没有提出任何有意义的事情.
Groovy 1.8文档有3种类型的JavaDoc:
api/gapi/jdk /
jdk/Javadocs显示了Groovy添加到Java类的方法.这很容易理解.
api /和gapi /中的JavaDocs令人困惑.它们是相似的,除了api /具有不区分大小写的All Classes显示,而gapi /具有所有类的区分大小写的显示.(区分大小写的显示器很难找到东西.)
gapi/All Classes列表在列表末尾有四个genXXX条目(再次区分大小写),它们似乎不在api/list中.
有谁知道api /和gapi/JavaDocs之间有什么区别?
谢谢.
如果我有一个项目有java
,groovy
和kotlin
插件应用每个代码编写的代码,我如何创建(我应该)创建一个javadoc.jar
包含所有代码文档的分发?
该java
插件给我的javadoc
课,groovy
插件给我的groovydoc
任务,但这些似乎并没有合作.
如何将此文档"合并"为单个内聚工件?
对于 Groovy 或 Java 类或方法,我通常会在文档注释(也称为 Javadoc 注释)中包含任何 API 级文档,而不是常规注释。添加有关 Groovy 脚本的此类注释的类似方法是什么?
我个人不太关心 Javadoc 工具是否获取文档。然而,有关 Groovy 脚本用途的文档在概念上似乎类似于类的文档注释;因此,我直觉地希望它们出现在文档评论中。如果我的直觉是错误的并且文档标签不是注释 Groovy 脚本意图的标准方式,那么记录脚本用途的首选方法是什么?
我有一个詹金斯全球图书馆,我想记录下来。我想使用groovydoc。
该库包含类和全局变量
src/<package-name>
vars
Run Code Online (Sandbox Code Playgroud)
生成类的文档没有问题:
groovydoc -sourcepath src -d doc 'main.pipeline' '*.groovy'
Run Code Online (Sandbox Code Playgroud)
但是,如何生成有关var的文档?
我有采用UTF-8编码的Groovy代码,并且需要生成的Groovydoc HTML才能使用相同的代码。但是我该如何在Gradle中配置呢?
我正在使用Gradle 1.5来测试我的Groovy脚本.build.gradle中的groovyDoc任务设置如下:
groovydoc {
docTitle = "Name"
windowTitle = "Name"
destinationDir = file('file://path')
}
Run Code Online (Sandbox Code Playgroud)
我在运行此任务时遇到的错误是:
FAILURE: Build failed with an exception.
* What went wrong:
Execution failed for task ':groovydoc'.
> java.lang.NoClassDefFoundError: org/fusesource/jansi/AnsiRenderWriter
Run Code Online (Sandbox Code Playgroud)
这只是在我对我的一个类进行了一个小的代码更改(添加一个If语句)后才开始发生的.我恢复到之前的提交,它没有这个问题.我尝试删除我在班级中的更改并重新启动相同的文件,但它仍然失败.
你有什么想法?