GroovyDoc as Maven Plugin

Question

Is there a maven plugin available somewhere that utilizes GroovyDoc, preferably as a report?

I guess GMaven would be the place to look but the docs are ancient (1.0, whereas the current version is 1.3) and the GMaven plugin doesn't have any mojo that fits as you can see:

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

This plugin has 9 goals:

groovy:compile
Description: Compiles Groovy sources.

groovy:console
Description: Launches the Groovy GUI console.

groovy:execute
Description: Executes a Groovy script.

groovy:generateStubs
Description: Generate Java stubs from Groovy sources.

groovy:generateTestStubs
Description: Generate Java stubs from Groovy test sources.

groovy:help
Description: Display help information on gmaven-plugin.
Call
mvn groovy:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details.

groovy:providers
Description: Displays information about the Groovy runtime providers which are configured and selected.

groovy:shell
Description: Launches the Groovy Shell (aka. groovysh).

groovy:testCompile
Description: Compiles Groovy test sources.

So does anyone have any pointers to a maven groovydoc plugin? Google didn't come up with anything meaningful.

The author of GMaven attempted a rewrite of the plugin a while back (https://github.com/keeganwitt/GMavenPlus). One of the goals was to provide support for GroovyDoc, but at the time of this writing, it hasn't been released yet. — sworisbreathing, Nov 19 '12 at 02:19
@sean-patrick-floyd I'm plan to release a beta this month. I'm working on setting up Maven repositories now. — Keegan, Jun 08 '13 at 03:48

score 9 · Answer 1 · answered Dec 07 '11 at 14:01

Although there is not any Groovydoc maven compatible plugin, generating the documentation for your groovy classes is quite easy using Maven. This is the way we do in our projects:

<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>

I'll accept this because it seems to work, even though I no longer have a need for it. — Sean Patrick Floyd, Dec 07 '11 at 14:12
Why do you no longer have a need for it? Did you find an alternate solution? — mindthief, Nov 05 '12 at 14:54

score 3 · Answer 2 · answered Mar 16 '11 at 22:52

I don't think there is a Maven plugin for Groovydoc, but you can use the Ant task. GMaven follows a different approach: generateStubs creates Java stubs for Groovy classes, which can then be processed by the regular Javadoc plugin. However, I don't know how well this approach works in practice, in particular because newer versions of GMaven use the Groovy compiler's stub generator, which wasn't created with the goal of producing proper Javadoc in mind.

score 2 · Accepted Answer · answered Jan 18 '17 at 19:04

2

You want the 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>

and run: mvn gplus:generateStubs gplus:groovydoc

answered Jan 18 '17 at 19:04

Sean

2,315
20
25

1

Too late for me, but hopefully it will help somebody else. Thanks! – Sean Patrick Floyd Jan 19 '17 at 12:57
It's generating empty documentation for me. Is there anything I am missing? – Paramesh Korrakuti Nov 11 '18 at 23:14
@ParameshKorrakuti what goals are you running? You did add javadocs/groovydocs to your actual source files, right? – Sean Nov 12 '18 at 15:11
@SeanPatrickFloyd added groovydics and executing `mvn gplus:generateStubs gplus:groovydoc` command. It's creating frames with empty documentation. – Paramesh Korrakuti Nov 14 '18 at 06:09
@ParameshKorrakuti I'm not sure why you'd have empty docs if you've actually got the javadoc sytle comments written in your code and are using the maven plugin as shown above. If you share a link to a github or similar, I'd be happy to poke around and see if I can help. – Sean Nov 14 '18 at 15:18

score 0 · Answer 4 · answered Aug 05 '14 at 23:52

0

The Groovydoc Maven Plugin worked for me: https://github.com/rvowles/groovydoc-maven-plugin

answered Aug 05 '14 at 23:52

xnickmx

1,037
1
11
18

GroovyDoc as Maven Plugin

4 Answers4

Linked