GroovydocMojo
, GroovydocTestsMojo
public abstract class AbstractGroovydocMojo extends AbstractGroovySourcesMojo
Modifier and Type | Field | Description |
---|---|---|
protected boolean |
displayAuthor |
Whether to display the author in the generated Groovydoc.
|
protected String |
docTitle |
The page title.
|
protected String |
footer |
The page footer.
|
protected static Version |
GROOVY_1_5_2 |
Groovy 1.5.2 version.
|
protected static Version |
GROOVY_1_5_8 |
Groovy 1.5.8 version.
|
protected static Version |
GROOVY_1_6_0_RC1 |
Groovy 1.6.0 RC-1 version.
|
protected static Version |
GROOVY_1_6_0_RC2 |
Groovy 1.6.0 RC-2 version.
|
protected boolean |
groovydocJavaSources |
Whether to include Java sources in groovydoc generation.
|
protected File |
groovydocOutputDirectory |
The location for the generated API docs.
|
protected String |
header |
The page header.
|
protected List<Link> |
links |
Links to include in the generated groovydoc (key is link href, value is
comma-separated packages to use that link).
|
protected File |
overviewFile |
The HTML file to be used for overview documentation.
|
protected String |
scope |
The scope to generate Groovydoc for.
|
protected String |
stylesheetEncoding |
The encoding of stylesheetFile.
|
protected File |
stylesheetFile |
The stylesheet file (absolute path) to copy to output directory (will
overwrite default stylesheet.css).
|
protected File |
testGroovydocOutputDirectory |
The location for the generated test API docs.
|
protected String |
windowTitle |
The window title.
|
classWrangler, GROOVY_1_5_0, GROOVY_SOURCES_PATTERN, JAVA_1_7, JAVA_SOURCES_PATTERN, minGroovyVersion, mojoExecution, pluginArtifacts, project, session, skipTests
MAIN, sources, TEST, testSources
Constructor | Description |
---|---|
AbstractGroovydocMojo() |
Modifier and Type | Method | Description |
---|---|---|
protected void |
copyStylesheet(File outputDirectory) |
Copies the stylesheet to the specified output directory.
|
protected Object |
createGroovyDocTool(Class groovyDocToolClass,
Class resourceManagerClass,
Properties docProperties,
Object classpathResourceManager,
List<String> sourceDirectories,
GroovyDocTemplateInfo groovyDocTemplateInfo,
List groovydocLinks) |
Instantiates a new GroovyDocTool.
|
protected void |
doGroovydocGeneration(org.apache.maven.shared.model.fileset.FileSet[] sourceDirectories,
List classpath,
File outputDirectory) |
Generates the Groovydoc for the specified sources.
|
protected void |
generateGroovydoc(File outputDirectory,
Class groovyDocToolClass,
Class outputToolClass,
Object fileOutputTool,
List<String> groovydocSources,
Object groovyDocTool) |
Performs the Groovydoc generation.
|
protected List<String> |
setupGroovyDocSources(org.apache.maven.shared.model.fileset.FileSet[] sourceDirectories,
org.apache.maven.shared.model.fileset.util.FileSetManager fileSetManager) |
Gets the Groovy sources without the Java sources (since the Java sources don't have Javadoc).
|
protected List |
setupLinks() |
Sets up the Groovydoc links.
|
protected Properties |
setupProperties() |
Sets up the documentation properties.
|
getJavaVersion, getJavaVersionString, groovyVersionSupportsAction, isJavaSupportIndy, logPluginClasspath
getFiles, getFilesets, getSourceRoots, getSourceRoots, getSources, getSources, getTestSourceRoots, getTestSourceRoots, getTestSources, getTestSources, setSources, setTestSources
protected static final Version GROOVY_1_6_0_RC2
protected static final Version GROOVY_1_6_0_RC1
protected static final Version GROOVY_1_5_8
protected static final Version GROOVY_1_5_2
protected File groovydocOutputDirectory
protected File testGroovydocOutputDirectory
protected String windowTitle
protected String docTitle
protected String footer
protected String header
protected boolean displayAuthor
protected File overviewFile
protected File stylesheetFile
protected String stylesheetEncoding
protected String scope
protected List<Link> links
protected boolean groovydocJavaSources
protected void doGroovydocGeneration(org.apache.maven.shared.model.fileset.FileSet[] sourceDirectories, List classpath, File outputDirectory) throws ClassNotFoundException, InvocationTargetException, IllegalAccessException, InstantiationException, MalformedURLException
sourceDirectories
- The source directories to generate groovydoc forclasspath
- The classpath to use for compilationoutputDirectory
- The directory to save the generated groovydoc inClassNotFoundException
- when a class needed for groovydoc generation cannot be foundInstantiationException
- when a class needed for groovydoc generation cannot be instantiatedIllegalAccessException
- when a method needed for groovydoc generation cannot be accessedInvocationTargetException
- when a reflection invocation needed for groovydoc generation cannot be completedMalformedURLException
- when a classpath element provides a malformed URLprotected Properties setupProperties()
protected List setupLinks() throws ClassNotFoundException, InvocationTargetException, IllegalAccessException, InstantiationException
ClassNotFoundException
- when a class needed for setting up Groovydoc links cannot be foundInstantiationException
- when a class needed for setting up Groovydoc links cannot be instantiatedIllegalAccessException
- when a method needed for setting up Groovydoc links cannot be accessedInvocationTargetException
- when a reflection invocation needed for setting up Groovydoc links cannot be completedprotected Object createGroovyDocTool(Class groovyDocToolClass, Class resourceManagerClass, Properties docProperties, Object classpathResourceManager, List<String> sourceDirectories, GroovyDocTemplateInfo groovyDocTemplateInfo, List groovydocLinks) throws InvocationTargetException, IllegalAccessException, InstantiationException
groovyDocToolClass
- the GroovyDocTool classresourceManagerClass
- the ResourceManager lassdocProperties
- the documentation propertiesclasspathResourceManager
- the ClasspathResourceManager for the GroovyDocToolsourceDirectories
- the source directories for the GroovyDocToolgroovyDocTemplateInfo
- the GroovyDocTemplateInfo for the GroovyDocToolgroovydocLinks
- the Groovydoc linksInstantiationException
- when a class needed for setting up Groovydoc tool cannot be instantiatedIllegalAccessException
- when a method needed for setting up Groovydoc tool cannot be accessedInvocationTargetException
- when a reflection invocation needed for setting up Groovydoc tool cannot be completedprotected List<String> setupGroovyDocSources(org.apache.maven.shared.model.fileset.FileSet[] sourceDirectories, org.apache.maven.shared.model.fileset.util.FileSetManager fileSetManager)
sourceDirectories
- the source directories to get the Groovy sources fromfileSetManager
- the FileSetmanager to use to get the included filesprotected void generateGroovydoc(File outputDirectory, Class groovyDocToolClass, Class outputToolClass, Object fileOutputTool, List<String> groovydocSources, Object groovyDocTool) throws InvocationTargetException, IllegalAccessException
outputDirectory
- the directory to output the Groovydoc togroovyDocToolClass
- the GroovyDocTool classoutputToolClass
- the OutputTool classfileOutputTool
- the FileOutputTool to use for Groovydoc generationgroovydocSources
- the sources togroovyDocTool
- the GroovyDocTool to use for Groovydoc generationIllegalAccessException
- when a method needed for Groovydoc generation cannot be accessedInvocationTargetException
- when a reflection invocation needed for Groovydoc generation cannot be completedprotected void copyStylesheet(File outputDirectory)
outputDirectory
- The output directory to copy the stylesheet toCopyright © 2011–2019. All rights reserved.