org.codehaus.mojo.javascript
Class JsDocReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.codehaus.mojo.javascript.AbstractJavascriptReport
              org.codehaus.mojo.javascript.JsDocReport

All Implemented Interfaces:

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

public class JsDocReport
extends AbstractJavascriptReport

Generate JsDoc report

Author:

nicolas De Loof

Is defined by the goal name:

jsdoc

Is bound to the specified phase of the standard build lifecycle:

site

Field Summary

protected java.io.File

sourceDirectory Location of the source files.

Fields inherited from class org.codehaus.mojo.javascript.AbstractJavascriptReport

outputDirectory

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

JsDocReport()

Method Summary

boolean	canGenerateReport()
protected void	executeReport(java.util.Locale locale)
protected java.lang.String	getName()
java.lang.String	getOutputName()
boolean	isExternalReport()

Methods inherited from class org.codehaus.mojo.javascript.AbstractJavascriptReport

copyScripts, evalScript, evalScript, evalScript, evalScript, evalScript, getBundle, getDescription, getLanguageVersion, getName, getOutputDirectory, getProject, getScripts, getSiteRenderer, getWorkDirectory, unpackJavascriptDependency

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

closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink, 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

Field Detail

sourceDirectory

protected java.io.File sourceDirectory

Location of the source files.

Is defined by:

default-value:

${basedir}/src/main/javascript

Constructor Detail

JsDocReport

public JsDocReport()

Method Detail

isExternalReport

public boolean isExternalReport()

Specified by:

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

Overrides:

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

getOutputName

public java.lang.String getOutputName()

Specified by:

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

Overrides:

getOutputName in class AbstractJavascriptReport

See Also:

MavenReport.getOutputName()

executeReport

protected void executeReport(java.util.Locale locale)
                      throws org.apache.maven.reporting.MavenReportException

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

See Also:

AbstractMavenReport.executeReport(java.util.Locale), http://code.google.com/p/jsdoc-toolkit/wiki/CmdlineOptions

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

Overrides:

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

See Also:

AbstractMavenReport.canGenerateReport()

getName

protected java.lang.String getName()

Specified by:

getName in class AbstractJavascriptReport

See Also:

AbstractJavascriptReport.getName()