Groovydoc como complemento Maven

Question

¿Hay un complemento Maven disponible en algún lugar que utilice? GroovyDoc, preferiblemente como informe?

Supongo Gmaven Sería el lugar para mirar, pero los documentos son antiguos (1.0, mientras que la versión actual es 1.3) y el complemento GMAVEN no tiene ningún mojo que se ajuste como puede ver:

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

Este complemento tiene 9 objetivos:

Groovy: compilar
Descripción: Compila fuentes maravillosas.

Groovy: Consola
Descripción: lanza la consola GUI Groovy.

Groovy: ejecutar
Descripción: ejecuta un script groovy.

Groovy: Generatestubs
Descripción: Genere los talones de Java a partir de fuentes groovy.

Groovy: GenerateTeststubs
Descripción: Genere los talones de Java a partir de fuentes de prueba groovy.

Groovy: ayuda
Descripción: Muestre información de ayuda sobre GMAVEN-Plugin.
Llamar
mvn groovy:help -Ddetail=true -Dgoal=<goal-name>
para mostrar detalles del parámetro.

Groovy: proveedores
Descripción: Muestra información sobre los proveedores de tiempo de ejecución groovy que están configurados y seleccionados.

Groovy: Shell
Descripción: lanza el shell groovy (también conocido como. Groovysh).

Groovy: TestCompile
Descripción: Compila fuentes de prueba maravillosas.

Entonces, ¿alguien tiene algún consejo para un complemento Maven GroovyDoc? A Google no se le ocurrió nada significativo.

Answer 1

Quieres el complemento 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>

y correr: mvn gplus:generateStubs gplus:groovydoc

Answer 2

Aunque no hay ningún complemento compatible con GroovyDoc Maven, generar la documentación para sus clases maravillosas es bastante fácil de usar Maven. Así es como lo hacemos en nuestros proyectos:

<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

No creo que haya un complemento Maven para Groovydoc, pero puedes usar el Tarea de hormigas. Gmaven sigue un enfoque diferente: generateStubs Crea stubs de Java para clases groovy, que luego pueden ser procesadas por el complemento Javadoc regular. Sin embargo, no sé qué tan bien funciona este enfoque en la práctica, en particular porque las versiones más nuevas de GMAVEN usan el generador de grietas del compilador, que no se creó con el objetivo de producir en mente a Javadoc adecuado.

Answer 4

El complemento Groovydoc Maven funcionó para mí: https://github.com/rvowles/groovydoc-maven-plugin