com.github.jlgrock.javascriptframework.jsdocs

Class JsDocsReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

com.github.jlgrock.javascriptframework.jsdocs.JsDocsReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport

public class JsDocsReport
extends org.apache.maven.reporting.AbstractMavenReport

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

Field Summary

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

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

ROLE

Constructor Summary

Constructors

Constructor and Description
JsDocsReport()

Method Summary

Methods

Modifier and Type	Method and Description
protected List<String>	createArgumentStack(Set<File> files) Create a list of arguments for the jsdoc toolkit.
protected void	executeReport(Locale localeIn) Execute the mojo, this is what mvn calls to start this mojo.
protected File	getBaseDir()
String	getDescription(Locale locale)
File	getJsDocAppLocation() The location of the JsDocApplication for use in the JsDocMojos.
String	getName(Locale locale)
protected String	getOutputDirectory()
File	getOutputDirectoryFile()
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
int	getrecurseDepth()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
Set<File>	getSourceFiles() This will get a listing of all of the files that should be used to create the jsdocs.
File	getTemplate()
File	getToolkitExtractDirectory()
boolean	isAllFunctions()
boolean	isExternalReport()
boolean	isForceUnique()
boolean	isIgnoreCode()
boolean	isIncludePrivate()
boolean	isIncludeSourceCode()

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

canGenerateReport, closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, setReportOutputDirectory

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

JsDocsReport

public JsDocsReport()

Method Detail

getToolkitExtractDirectory

public final File getToolkitExtractDirectory()

Returns:

the toolkitExtractDirectory

getBaseDir

protected final File getBaseDir()

Returns:

the base directory

isAllFunctions

public final boolean isAllFunctions()

Returns:

allFunctions parameter

isIgnoreCode

public final boolean isIgnoreCode()

Returns:

ignoreCode

isIncludeSourceCode

public final boolean isIncludeSourceCode()

Returns:

includeSourceCode

getOutputDirectoryFile

public final File getOutputDirectoryFile()

Returns:

outputDirectory

isIncludePrivate

public final boolean isIncludePrivate()

Returns:

the includePrivate

getrecurseDepth

public final int getrecurseDepth()

Returns:

recurseDepth;

getTemplate

public final File getTemplate()

Returns:

the template

isForceUnique

public final boolean isForceUnique()

Returns:

forceUnique

getJsDocAppLocation

public final File getJsDocAppLocation()

The location of the JsDocApplication for use in the JsDocMojos.

Returns:

the run.js file location

executeReport

protected final void executeReport(Locale localeIn)
                            throws org.apache.maven.reporting.MavenReportException

Execute the mojo, this is what mvn calls to start this mojo.

Specified by:

executeReport in class org.apache.maven.reporting.AbstractMavenReport

Parameters:

localeIn - the Locale In

Throws:

org.apache.maven.reporting.MavenReportException - TODO

getOutputDirectory

protected final String getOutputDirectory()

Specified by:

getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

getProject

protected final org.apache.maven.project.MavenProject getProject()

Specified by:

getProject in class org.apache.maven.reporting.AbstractMavenReport

getSiteRenderer

protected final org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Specified by:

getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

getDescription

public final String getDescription(Locale locale)

getName

public final String getName(Locale locale)

getOutputName

public final String getOutputName()

isExternalReport

public final boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

Overrides:

isExternalReport in class org.apache.maven.reporting.AbstractMavenReport

createArgumentStack

protected final List<String> createArgumentStack(Set<File> files)
                                          throws org.apache.maven.reporting.MavenReportException

Create a list of arguments for the jsdoc toolkit.

Parameters:

files - the files to create jsdocs for

Returns:

the list of arguments

Throws:

org.apache.maven.reporting.MavenReportException - whenever the necessary arguments have been passed in incorrectly or if there is a problem with one of the parameters sent in

getSourceFiles

public final Set<File> getSourceFiles()

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

Returns:

the set of files