GroovyDoc作为Maven插件

Question

是否有可以使用的maven插件GroovyDoc,最好是作为报告使用？

我猜GMaven是一个值得一看的地方,但是文档是古老的(1.0,而当前版本是1.3),GMaven插件没有任何适合你的mojo:

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

这个插件有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插件的指针？谷歌没有提出任何有意义的事情.

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