GroovyDoc comme Maven Plugin

Question

Y at-il un plugin maven disponible quelque part qui utilise GroovyDoc , de préférence en rapport?

Je suppose que GMaven serait l'endroit idéal pour regarder, mais les documents sont anciens (1.0 , alors que la version actuelle est 1.3) et le plug-in GMaven n'a pas mojo qui correspond comme vous pouvez le voir:

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

Ce plugin a 9 buts:

groovy: Compile Description: Compile sources Groovy.

groovy: console Description: lance la console GUI Groovy.

groovy: exécuter Description: Exécute un script Groovy.

groovy: generateStubs La description: Générer stubs Java de Groovy sources.

groovy: generateTestStubs Description: Générer stubs Java à partir de sources de test Groovy.

groovy: help Description: Affichage informations sur l'aide-plugin gmaven.
Appel
mvn groovy:help -Ddetail=true -Dgoal=<goal-name>
aux détails des paramètres d'affichage.

groovy: fournisseurs La description: Affiche des informations sur les Groovy fournisseurs d'exécution qui sont configurés et sélectionnés.

groovy: shell Description: lance le Groovy Shell (aka. groovysh).

groovy: testCompile La description: Compile sources de test Groovy.

Quelqu'un at-il des pointeurs vers un plugin maven groovydoc? Google ne est pas venu avec quelque chose de significatif.

Answer 1

Vous voulez le 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>

et exécutez: mvn gplus:generateStubs gplus:groovydoc

Answer 2

Bien qu'il n'y ait pas de plug-in compatible Groovydoc Maven, générer la documentation pour vos classes groovy est assez facile à utiliser Maven. Ceci est la façon dont nous le faisons dans nos projets:

<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

Je ne pense pas qu'il y ait un plugin Maven pour Groovydoc, mais vous pouvez utiliser le tâche Ant . GMaven suit une approche différente: generateStubs crée stubs Java pour les classes Groovy, qui peuvent ensuite être traitées par le plug-in Javadoc régulière. Cependant, je ne sais pas à quel point cette approche fonctionne dans la pratique, en particulier parce que les versions les plus récentes de GMaven utilisent le générateur de stub de compilateur Groovy, qui n'a pas été créé dans le but de produire Javadoc appropriée à l'esprit.

Answer 4

Le Groovydoc Maven Plugin a fonctionné pour moi: https://github.com/rvowles/groovydoc- maven-plugin