Grovydoc作为Maven插件

Question

是否有使用Maven插件的地方 GroovyDoc, ，最好是报告？

我猜 Gmaven 将是看的地方，但文档是古老的（1.0，而当前版本为1.3），而gmaven插件没有任何适合您所看到的魔力：

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

该插件有9个目标：

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

Groovy：控制台
描述：启动GUOVY GUI控制台。

Groovy：执行
描述：执行一个Groovy脚本。

Groovy：GenerateStubs
描述：从Groovy来源生成Java存根。

Groovy：GenerateTestStubs
描述：从Groovy测试来源生成Java存根。

Groovy：帮助
描述：显示有关Gmaven-Plugin的帮助信息。
称呼
mvn groovy:help -Ddetail=true -Dgoal=<goal-name>
显示参数详细信息。

Groovy：提供者
描述：显示有关配置和选择的Groovy运行时提供商的信息。

Groovy：外壳
描述：启动Groovy Shell（又名Grovysh）。

Groovy：TestCompile
描述：编译Groovy测试来源。

那么，有人对Maven Grovydoc插件有任何指针吗？ Google没有提出任何有意义的东西。

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

尽管没有任何GrovyDoc 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 3

我认为没有用于Grovydoc的Maven插件，但是您可以使用 蚂蚁任务. 。 gmaven遵循另一种方法： generateStubs 为Groovy类创建Java Stubs，然后可以通过常规Javadoc插件处理。但是，我不知道这种方法在实践中的运作效果如何，特别是因为Gmaven的新版本使用Groovy编译器的存根生成器，该生成器的目的不是为了产生适当的Javadoc而创建。

Answer 4

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