GroovyDoc 作为 Maven 插件

Question

是否有可用的 Maven 插件使用 GroovyDoc，最好是作为报告？

我想 GMaven 会是一个值得一看的地方，但文档很古老（1.0，而当前版本是 1.3）并且 GMaven 插件没有任何适合的魔力，如您所见：

mvn help:describe -DgroupId=org.codehaus.gmaven -DartifactId=gmaven-plugin

这个插件有 9 个目标：

groovy:编译
描述：编译 Groovy 来源。

groovy：控制台
描述： 发射 Groovy GUI 控制台。

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

groovy:generateStubs
描述： 从 Groovy 生成 Java 存根 来源。

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

groovy：帮助
描述：显示 有关 gmaven-plugin 的帮助信息。
致电
mvn groovy:help -Ddetail=true -Dgoal=<目标名称>
显示参数详细信息。

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

groovy:shell
描述： 发射 Groovy Shell（又名 groovysh）。

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

那么有人有任何指向 Maven groovydoc 插件的指示吗？谷歌没有想出任何有意义的东西。

Answer 1

尽管没有任何 Groovydoc maven 兼容插件，但使用 Maven 为您的 groovy 类生成文档非常容易。这就是我们在项目中所做的方式：

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-antrun-plugin</artifactId>
  <version>1.7</version>
  <executions>
    <execution>
      <id>groovydoc</id>
      <phase>site</phase>
      <goals>
        <goal>run</goal>
      </goals>
      <configuration>
        <target>
          <taskdef name="groovydoc"
            classname="org.codehaus.groovy.ant.Groovydoc" 
            classpathref="maven.compile.classpath"
          />
          <groovydoc destdir="${project.reporting.outputDirectory}/groovydoc"
            sourcepath="${basedir}/src/main/groovy" use="true"
            windowtitle="${project.name}"
            doctitle="${project.name}"
          >
            <link packages="java.,org.xml.,javax.,org.xml."
              href="http://download.oracle.com/javase/6/docs/api" />
            <link packages="org.apache.tools.ant." 
              href="http://evgeny-goldin.org/javadoc/ant/api" />
            <link packages="org.junit.,junit.framework."
              href="http://kentbeck.github.com/junit/javadoc/latest" />
            <link packages="groovy.,org.codehaus.groovy."
              href="http://groovy.codehaus.org/api/" />
            <link packages="org.codehaus.gmaven."
              href="http://evgeny-goldin.org/javadoc/gmaven" />
          </groovydoc>
        </target>
      </configuration>
    </execution>
  </executions>
</plugin>

Answer 2

您需要 gmavenplus 插件： http://groovy.github.io/GMavenPlus/groovydoc- mojo.html

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.codehaus.gmavenplus</groupId>
        <artifactId>gmavenplus-plugin</artifactId>
        <version>1.5</version>
      </plugin>
    </plugins>
  </build>
  <dependencies>
    <dependency>
      <groupId>org.codehaus.groovy</groupId>
      <artifactId>groovy-all</artifactId>
      <!-- any version of Groovy \>= 1.5.0 (except 1.6 RC 1) should work here -->
      <version>2.4.7</version>
    </dependency>
  </dependencies>
</project>

并运行：mvn gplus:generateStubs gplus:groovydoc

Answer 3

我认为 Groovydoc 没有 Maven 插件，但您可以使用 Ant 任务< /a>. GMaven 采用不同的方法：generateStubs 为 Groovy 类创建 Java 存根，然后可以由常规 Javadoc 插件进行处理。然而，我不知道这种方法在实践中效果如何，特别是因为较新版本的 GMaven 使用 Groovy 编译器的存根生成器，而创建该生成器的目的并不是生成正确的 Javadoc。

Answer 4

Groovydoc Maven 插件对我有用： https://github.com/rvowles/groovydoc-maven-plugin