org.codehaus.gmavenplus.groovyworkarounds

Class GroovyDocTemplateInfo

java.lang.Object

org.codehaus.gmavenplus.groovyworkarounds.GroovyDocTemplateInfo

public class GroovyDocTemplateInfo
extends Object

This class was taken mostly from the Groovy project (GroovyDocTemplateInfo.java and GroovyDoc.java) because it wasn't available prior to Groovy 1.7.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DOCGEN_BASEDIR Base directory of document generation classes.
protected static Version	GROOVY_1_6_0 Groovy 1.6.0 version.
protected static Version	GROOVY_1_6_0_RC2 Groovy 1.6.0 RC-2 version.
protected static Version	GROOVY_1_6_2 Groovy 1.6.2 version.
protected Version	groovyVersion The version of Groovy whose locations to use for Groovydoc templates.
protected String	templateBaseDir Base directory of templates.

Constructor Summary

Constructors

Constructor and Description
GroovyDocTemplateInfo(Version version) Constructs a new GroovyDocTemplateInfo using the specified Groovy version to determine templates location.

Method Summary

Modifier and Type	Method and Description
String[]	defaultClassTemplates()
String[]	defaultDocTemplates()
String[]	defaultPackageTemplates()

Methods inherited from class java.lang.Object

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

Field Detail

DOCGEN_BASEDIR

protected static final String DOCGEN_BASEDIR

Base directory of document generation classes.

See Also:

Constant Field Values

GROOVY_1_6_2

protected static final Version GROOVY_1_6_2

Groovy 1.6.2 version.

GROOVY_1_6_0

protected static final Version GROOVY_1_6_0

Groovy 1.6.0 version.

GROOVY_1_6_0_RC2

protected static final Version GROOVY_1_6_0_RC2

Groovy 1.6.0 RC-2 version.

groovyVersion

protected Version groovyVersion

The version of Groovy whose locations to use for Groovydoc templates.

templateBaseDir

protected String templateBaseDir

Base directory of templates.

Constructor Detail

GroovyDocTemplateInfo

public GroovyDocTemplateInfo(Version version)

Constructs a new GroovyDocTemplateInfo using the specified Groovy version to determine templates location.

Parameters:

version - the version of Groovy whose locations to use for templates

Method Detail

defaultDocTemplates

public String[] defaultDocTemplates()

defaultPackageTemplates

public String[] defaultPackageTemplates()

defaultClassTemplates

public String[] defaultClassTemplates()