org.codehaus.gmavenplus.mojo

Class GroovydocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.gmavenplus.mojo.AbstractGroovyMojo

org.codehaus.gmavenplus.mojo.AbstractGroovySourcesMojo

org.codehaus.gmavenplus.mojo.AbstractGroovydocMojo

org.codehaus.gmavenplus.mojo.GroovydocMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class GroovydocMojo
extends AbstractGroovydocMojo

Generates Groovydoc for the main sources Note that this mojo requires Groovy >= 1.6.2.

Author:

Keegan Witt

Field Summary

Fields inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovydocMojo

displayAuthor, docTitle, footer, groovydocJavaSources, groovydocOutputDirectory, header, links, MIN_GROOVY_VERSION, overviewFile, scope, stylesheetEncoding, stylesheetFile, testGroovydocOutputDirectory, windowTitle

Fields inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovySourcesMojo

MAIN, sources, TEST, testSources

Fields inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovyMojo

GROOVY_SOURCES_PATTERN, JAVA_SOURCES_PATTERN, localRepository, pluginArtifacts, project, reactorProjects, session, settings

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
GroovydocMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Executes this mojo.

Methods inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovydocMojo

generateGroovydoc, groovyVersionSupportsAction

Methods inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovySourcesMojo

getFiles, getFilesets, getSourceRoots, getSourceRoots, getSources, getSources, getTestSourceRoots, getTestSourceRoots, getTestSources, getTestSources, setSources, setTestSources

Methods inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovyMojo

getGroovyDependency, getGroovyVersion, getGroovyVersionString, getJavaVersion, getJavaVersionString, isGroovyArtifactId, isGroovyArtifactId, isGroovyGroupId, isGroovyGroupId, isGroovyIndy, isJavaSupportIndy, logGroovyVersion

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroovydocMojo

public GroovydocMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Executes this mojo.

Throws:

org.apache.maven.plugin.MojoExecutionException - If an unexpected problem occurs. Throwing this exception causes a "BUILD ERROR" message to be displayed

org.apache.maven.plugin.MojoFailureException - If an expected problem (such as a compilation failure) occurs. Throwing this exception causes a "BUILD FAILURE" message to be displayed