com.github.jlgrock.javascriptframework.jsdocs
Class JsDocsMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      com.github.jlgrock.javascriptframework.jsdocs.AbstractJsDocsMojo
          com.github.jlgrock.javascriptframework.jsdocs.JsDocsMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AggregateJsDocsMojo, JsDocsJsarMojo, TestJsDocsMojo

public class JsDocsMojo
extends AbstractJsDocsMojo

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

Field Summary

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

ROLE

Constructor Summary

JsDocsMojo()

Method Summary

void	generate(org.apache.maven.doxia.sink.Sink aSink, org.apache.maven.doxia.sink.SinkFactory aSinkFactory, Locale aLocale) This method is called when the report generation is invoked by maven-site-plugin.
protected File	getArchiveOutputDirectory() return the file location of where the archive of the jsdocs should be placed.
protected String	getClassifier() The classifier that will be used for the file name.
protected File	getReportOutputDirectory()
ArrayList<File>	getSourceDirectories()
protected boolean	isAggregator()
static void	main(String[] args)

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

JsDocsMojo

public JsDocsMojo()

Method Detail

getSourceDirectories

public ArrayList<File> getSourceDirectories()

Specified by:

getSourceDirectories in class AbstractJsDocsMojo

Returns:

the sourceDirectory

isAggregator

protected boolean isAggregator()

Specified by:

isAggregator in class AbstractJsDocsMojo

Returns:

aggregator

getClassifier

protected 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

generate

public void generate(org.apache.maven.doxia.sink.Sink aSink,
                     org.apache.maven.doxia.sink.SinkFactory aSinkFactory,
                     Locale aLocale)
              throws org.apache.maven.reporting.MavenReportException

This method is called when the report generation is invoked by maven-site-plugin.

Parameters:

aSink -

aSinkFactory -

aLocale -

Throws:

org.apache.maven.reporting.MavenReportException

main

public static void main(String[] args)

getArchiveOutputDirectory

protected 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

getReportOutputDirectory

protected File getReportOutputDirectory()

Returns:

reportOutputDirectory