GroovyDoc como complemento de Maven

Question

¿Hay un complemento maven disponible en alguna parte que utilice GroovyDoc, preferiblemente como un informe?

supongo GMaven sería el lugar para buscar, pero los documentos son antiguos (1,0, mientras que la versión actual es la 1.3) y el plugin GMaven no tiene ningún mojo que se ajuste como se puede ver:

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

Este plugin tiene 9 goles:

maravilloso: compilar
Descripción: compila fuentes maravillosas.

maravilloso: la consola
Descripción: Lanza la consola maravillosa interfaz gráfica de usuario.

maravilloso: ejecutar
Descripción: Ejecuta un guión maravilloso.

maravilloso: generateStubs
Descripción: Generar recibos de Java desde Groovy fuentes.

maravilloso: generateTestStubs
Descripción: Generar recibos de Java a partir de fuentes de prueba maravillosos.

maravilloso: ayudar a
Descripción: Muestra información de ayuda sobre -plugin gmaven.
Llame
mvn groovy:help -Ddetail=true -Dgoal=<goal-name>
para mostrar los detalles del parámetro.

maravilloso: los proveedores de
Descripción: Muestra información sobre los proveedores de tiempo de ejecución maravilloso cuales configurados y seleccionados.

maravilloso: Shell
Descripción: lanza el Shell Groovy (aka groovysh.).

maravilloso: testCompile
Descripción: Compila las fuentes de prueba maravillosos.

¿Alguien tiene alguna sugerencia para un plugin de maven groovydoc? Google no encontró nada significativo.

Answer 1

Quiere el plugin 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 ejecute: mvn gplus:generateStubs gplus:groovydoc

Answer 2

No creo que haya un complemento Maven para Groovydoc, pero puede usar el Ant task. GMaven sigue un enfoque diferente: generateStubs crea los stubs de Java para las clases de Groovy, que luego pueden ser procesados ​​por el plugin regular de Javadoc.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 stub del compilador Groovy, que no fue creado con el objetivo de producir Javadoc adecuado en mente.

Answer 3

Aunque no hay ningún complemento compatible con Groovydoc maven, la generación de la documentación para sus clases de Groovy es bastante fácil con Maven. Esta es la forma en que 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 4

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