Groovydoc als Maven -Plugin

Question

Gibt es irgendwo ein Maven -Plugin, das verwendet wird, das verwendet? GroovyDoc, vorzugsweise als Bericht?

ich vermute Gmaven Wäre der Ort zum Aussehen, aber die Dokumente sind uralt (1.0, während die aktuelle Version 1.3 ist) und das Gmaven -Plugin hat kein Mojo, das wie Sie sehen können:

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

Dieses Plugin hat 9 Tore:

Groovy: Compile
Beschreibung: Kompiliert groovige Quellen.

Groovy: Konsole
Beschreibung: Startet die groovige GUI -Konsole.

Groovy: Ausführen
Beschreibung: führt ein grooviges Skript aus.

Groovy: Generatestubs
Beschreibung: Generieren Sie Java -Stubs aus groovigen Quellen.

Groovy: GeneratetestStubs
Beschreibung: Generieren Sie Java -Stubs aus groovigen Testquellen.

Groovy: Hilfe
Beschreibung: Hilfsinformationen zu Gmaven-Plugin anzeigen.
Anruf
mvn groovy:help -Ddetail=true -Dgoal=<goal-name>
Parameterdetails anzeigen.

Groovy: Anbieter
Beschreibung: Zeigt Informationen zu den Groovy -Laufzeitanbietern an, die konfiguriert und ausgewählt sind.

Groovy: Shell
Beschreibung: Startet die Groovy Shell (auch bekannt als Groovysh).

Groovy: TestCompile
Beschreibung: Kompiliert groovige Testquellen.

Hat jemand irgendwelche Hinweise auf ein Maven Groovydoc -Plugin? Google hatte nichts Sinnvolles.

Answer 1

Sie möchten das Gmavenplus -Plugin: 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>

und Renn: mvn gplus:generateStubs gplus:groovydoc

Answer 2

Obwohl es kein Groovydoc -Maven -kompatibler Plugin gibt, ist die Erzeugung der Dokumentation für Ihre Groovy -Klassen mit Maven ganz einfach. So machen wir in unseren Projekten:

<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

Ich glaube nicht, dass es ein Maven -Plugin für Groovydoc gibt, aber Sie können das verwenden Ameisenaufgabe. Gmaven folgt einem anderen Ansatz: generateStubs Erstellt Java Stubs für Groovy -Klassen, die dann vom regulären Javadoc -Plugin verarbeitet werden können. Ich weiß jedoch nicht, wie gut dieser Ansatz in der Praxis funktioniert, insbesondere weil neuere Versionen von Gmaven den Stubgenerator des Groovy Compilers verwenden, der nicht mit dem Ziel erzeugt wurde, angemessene Javadoc zu erzeugen.

Answer 4

Das Groovydoc Maven -Plugin hat für mich funktioniert: https://github.com/rvowles/groovydoc-maven-plugin