Package 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

Direct Known Subclasses:

GroovyDocJarMojo

@Mojo(name="groovydoc",
      requiresDependencyResolution=RUNTIME,
      threadSafe=true)
public class GroovyDocMojo
extends AbstractGroovyDocMojo

Generates GroovyDoc for the main sources.

Since:

1.0-beta-1

Author:

Keegan Witt

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	groovyDocJavaSources	Whether to include Java sources in GroovyDoc generation.
protected File	groovyDocOutputDirectory	The location for the generated API docs.
protected org.apache.maven.shared.model.fileset.FileSet[]	sources	The Groovy source files (relative paths).

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

attachGroovyDocAnnotation, classpathResourceManagerClass, defaultClassTemplates, defaultDocTemplates, defaultPackageTemplates, displayAuthor, docTitle, fileOutputToolClass, footer, GROOVY_1_5_2, GROOVY_1_5_8, GROOVY_1_6_0_RC1, GROOVY_1_6_0_RC2, GROOVY_3_0_0_ALPHA_4, groovyDocToolClass, header, includeClasspath, linkArgumentClass, links, outputToolClass, overviewFile, resourceManagerClass, scope, skipGroovyDoc, stylesheetEncoding, stylesheetFile, windowTitle

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

MAIN, TEST

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

classWrangler, GROOVY_1_5_0, GROOVY_SOURCES_PATTERN, JAVA_1_7, JAVA_1_8, JAVA_12, JAVA_SOURCES_PATTERN, minGroovyVersion, mojoExecution, pluginArtifacts, project, session

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

ROLE

Constructor Summary

Constructors

Constructor	Description
GroovyDocMojo()

Method Summary

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

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

copyStylesheet, createGroovyDocTool, doGroovyDocGeneration, generateGroovyDoc, setupGroovyDocSources, setupLinks, setupProperties

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

getFiles, getFilesets, getTestFiles, getTestFilesets

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

getJavaVersion, getJavaVersionString, groovyAtLeast, groovyIs, groovyNewerThan, groovyOlderThan, groovyVersionSupportsAction, isGroovyIndy, isJavaSupportIndy, isJavaSupportParameters, isJavaSupportPreviewFeatures, logPluginClasspath, setupClassWrangler

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

Field Details

sources

@Parameter
protected org.apache.maven.shared.model.fileset.FileSet[] sources

The Groovy source files (relative paths). Default: "${project.basedir}/src/main/groovy/**/*.groovy"

groovyDocOutputDirectory

@Parameter(defaultValue="${project.build.directory}/gapidocs")
protected File groovyDocOutputDirectory

The location for the generated API docs.

groovyDocJavaSources

@Parameter(defaultValue="true")
protected boolean groovyDocJavaSources

Whether to include Java sources in GroovyDoc generation.

Since:

1.0-beta-2

Constructor Details

GroovyDocMojo

public GroovyDocMojo()

Method Details

execute

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

Executes this mojo.

Throws:

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