GroovyDoc作为Maven插件

Question

是否有一个可以利用GroovyDoc的maven插件，最好作为报告使用？

我想GMaven应该是一个可以查看的地方，但是文档是古老的(1.0，而当前的版本是1.3)，而且GMaven插件没有任何适合您的方式，如您所见：

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

这个插件有9个目标： groovy:compile 描述:编译Groovy源代码。 groovy:console 描述:启动Groovy控制台。 groovy:execute 描述:执行Groovy脚本。 groovy:generateStubs 描述:从Groovy源生成Java存根。 groovy:generateTestStubs 描述:从Groovy测试源生成Java存根。 groovy:帮助 描述:显示关于gmaven插件的帮助信息。 打电话 mvn groovy:help -Ddetail=true -Dgoal=<goal-name> 若要显示参数细节，请执行以下操作。 groovy:providers 描述:显示有关配置和选择的Groovy运行时提供程序的信息。 groovy:shell 描述:启动Groovy (又名)。(格罗维什) groovy:testCompile 描述:编译Groovy测试源。

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

Answer 1

你想要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 2

尽管没有任何Groovydoc兼容插件，但是使用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 3

我不认为有一个用于Groovydoc的Maven插件，但是可以使用蚂蚁任务。GMaven遵循一种不同的方法：generateStubs为Groovy类创建Javadoc，然后由常规的Javadoc插件进行处理。但是，我不知道这种方法在实践中的效果如何，特别是因为更新版本的GMaven使用了Groovy编译器的存根生成器，创建这个生成器的目的不是为了产生合适的Javadoc。