com.github.jlgrock.javascriptframework.jsdocs

Class AbstractJsDocsAggMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.jlgrock.javascriptframework.jsdocs.AbstractJsDocsMojo

com.github.jlgrock.javascriptframework.jsdocs.AbstractJsDocsAggMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AggregatorJsDocsJsarMojo, AggregatorJsDocsMojo, AggregatorJsTestDocsJsarMojo, AggregatorJsTestDocsMojo

public abstract class AbstractJsDocsAggMojo
extends AbstractJsDocsMojo

An abstract class that aids in generating the common source Files.

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractJsDocsAggMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	extractAggFiles() Extract the interns (assert/debug) files from the package.
protected File	getAggregationFilesLocation()
Set<File>	getSourceFiles() This will get a listing of all of the files that should be used to create the jsdocs.

Methods inherited from class com.github.jlgrock.javascriptframework.jsdocs.AbstractJsDocsMojo

archive, createArgumentStack, generateArchive, getArchive, getArchiveOutputDirectory, getBaseDir, getClassifier, getDefaultManifestFile, getExtensionFormat, getFinalName, getJarArchiver, getJsDocAppLocation, getOutputDirectory, getProject, getProjectHelper, getRecurseDepth, getTemplate, getToolkitExtractDirectory, isAllFunctions, isForceUnique, isIgnoreCode, isIncludePrivate, isIncludeSourceCode, isUseDefaultManifestFile

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

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

execute

Constructor Detail

AbstractJsDocsAggMojo

public AbstractJsDocsAggMojo()

Method Detail

getAggregationFilesLocation

protected final File getAggregationFilesLocation()

Returns:

aggregationFiles

getSourceFiles

public final Set<File> getSourceFiles()

Description copied from class: AbstractJsDocsMojo

This will get a listing of all of the files that should be used to create the jsdocs.

Specified by:

getSourceFiles in class AbstractJsDocsMojo

Returns:

the set of files

extractAggFiles

protected final void extractAggFiles()

Extract the interns (assert/debug) files from the package.