com.github.jlgrock.javascriptframework.jsdocs

Class TestJsDocsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.jlgrock.javascriptframework.jsdocs.AbstractJsDocsMojo

com.github.jlgrock.javascriptframework.jsdocs.JsDocsMojo

com.github.jlgrock.javascriptframework.jsdocs.TestJsDocsMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

TestAggregateJsDocsMojo, TestJsDocsJsarMojo

public class TestJsDocsMojo
extends JsDocsMojo

Generates and aggregates javascript docs, from the jsdoc-toolkit (the final version) and stores them into a js archive.

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
TestJsDocsMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getClassifier() The classifier that will be used for the file name.
File	getReportOutputDirectory()
ArrayList<File>	getSourceDirectories()

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

generate, getArchiveOutputDirectory, isAggregator

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

archive, createArgumentStack, createJsDocs, execute, executeJSDocs, getBaseDir, getDestDir, getFinalName, getOutputDirectory, getTemplate, getToolkitExtractDirectory, isCaseSensitive, isIncludePrivate, isUseNamespacedFiles, setConsoleOuput, setOutputDirectory

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

TestJsDocsMojo

public TestJsDocsMojo()

Method Detail

getSourceDirectories

public final ArrayList<File> getSourceDirectories()

Overrides:

getSourceDirectories in class JsDocsMojo

Returns:

the sourceDirectory

getReportOutputDirectory

public final File getReportOutputDirectory()

Overrides:

getReportOutputDirectory in class JsDocsMojo

Returns:

the output directory for the report

getClassifier

protected final String getClassifier()

Description copied from class: AbstractJsDocsMojo

The classifier that will be used for the file name.

Overrides:

getClassifier in class JsDocsMojo

Returns:

the classifier