com.github.jlgrock.javascriptframework.jsdocs

Class JsTestDocsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.jlgrock.javascriptframework.jsdocs.AbstractJsDocsMojo

com.github.jlgrock.javascriptframework.jsdocs.AbstractJsDocsNonAggMojo

com.github.jlgrock.javascriptframework.jsdocs.JsTestDocsMojo

All Implemented Interfaces:

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

public class JsTestDocsMojo
extends AbstractJsDocsNonAggMojo

Generates javascript docs from the jsdoc-toolkit (the final version).

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
JsTestDocsMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
File	getArchiveOutputDirectory() return the file location of where the archive of the jsdocs should be placed.
String	getClassifier() The classifier that will be used for the file name.
File	getOutputDirectory()

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

getSourceFiles

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

archive, createArgumentStack, generateArchive, getArchive, getBaseDir, getDefaultManifestFile, getExtensionFormat, getFinalName, getJarArchiver, getJsDocAppLocation, 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

Constructor Detail

JsTestDocsMojo

public JsTestDocsMojo()

Method Detail

getOutputDirectory

public final File getOutputDirectory()

Specified by:

getOutputDirectory in class AbstractJsDocsMojo

Returns:

outputDirectory

getClassifier

public final String getClassifier()

Description copied from class: AbstractJsDocsMojo

The classifier that will be used for the file name.

Specified by:

getClassifier in class AbstractJsDocsMojo

Returns:

the classifier

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getArchiveOutputDirectory

public final File getArchiveOutputDirectory()

Description copied from class: AbstractJsDocsMojo

return the file location of where the archive of the jsdocs should be placed. This should return null if no archive is expected to be created.

Specified by:

getArchiveOutputDirectory in class AbstractJsDocsMojo

Returns:

the output directory or null in the case that it does not archive