GroovyDoc come Maven Plugin

Question

C'è un esperto di plug-in disponibile da qualche parte che utilizza GroovyDoc , preferibilmente come un rapporto?

GMaven sarebbe il posto dove guardare, ma la documentazione sono antiche (1.0 , mentre la versione corrente è 1.3) e il plugin GMaven non ha alcun mojo che si adatta come si può vedere:

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

Questo plugin dispone di 9 obiettivi:

Groovy: compilazione
Descrizione: Compila fonti Groovy.

Groovy: console
Descrizione: lancia la console Groovy GUI.

Groovy: eseguire
Descrizione: Esegue un Groovy script.

groove: generateStubs
Descrizione: Genera stub Java da Groovy fonti.

groove: generateTestStubs
Descrizione: Generare stub Java fonti di prova Groovy.

Groovy: help
Descrizione: Visualizzazione informazioni di aiuto sul gmaven-plugin.
chiamare
mvn groovy:help -Ddetail=true -Dgoal=<goal-name>
Per visualizzare i dettagli dei parametri.

groove: fornitori
Descrizione: Visualizza informazioni sul Groovy fornitori di runtime che sono configurati e selezionati.

Groovy: shell
Descrizione: lancia Shell Groovy (aka. groovysh).

Groovy: testCompile
Descrizione: Compila Groovy fonti di prova.

Quindi, chiunque ha di puntatori a un esperto di groovydoc plug-in? Google non è venuto su con qualcosa di significativo.

Answer 1

Si desidera il 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>

ed eseguire: mvn gplus:generateStubs gplus:groovydoc

Answer 2

Anche se non c'è alcun plugin compatibile con Groovydoc Maven, generando la documentazione per le classi Groovy è abbastanza facile usando Maven. Questo è il nostro modo di fare nei nostri progetti:

<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

Non credo ci sia un plugin Maven per Groovydoc, ma è possibile utilizzare il Ant compito. GMaven segue un approccio diverso: generateStubs crea stub Java per le classi Groovy, che possono poi essere elaborati dal plugin di regolare Javadoc. Tuttavia, non so quanto bene questo approccio funziona, in pratica, in particolare a causa versioni più recenti di GMaven utilizzano generatore stub del compilatore Groovy, che non è stato creato con l'obiettivo di produrre una corretta Javadoc in mente.

Answer 4

Il Maven plugin Groovydoc ha funzionato per me: https://github.com/rvowles/groovydoc- maven-plugin