org.nanoko.coffee.mill.mojos.reporting
Class JsDocMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.nanoko.coffee.mill.mojos.reporting.JsDocMojo

All Implemented Interfaces:

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

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

Builds the JSDoc API. It uses JSDoc3 but requires to have the jsdoc executable in the path.

Field Summary

protected boolean	jsdocIncludePrivate Whether to include symbols tagged as private.
protected String	outputDirectory Directory where reports will go.
protected org.apache.maven.project.MavenProject	project
protected org.apache.maven.doxia.siterenderer.Renderer	siteRenderer
protected boolean	skipJSDOC

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

JsDocMojo()

Method Summary

void	execute()
protected void	executeReport(Locale locale)
String	getDescription(Locale locale)
String	getName(Locale locale)
protected String	getOutputDirectory()
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
boolean	isExternalReport()

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

canGenerateReport, closeReport, 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

skipJSDOC

protected boolean skipJSDOC

jsdocIncludePrivate

protected boolean jsdocIncludePrivate

Whether to include symbols tagged as private. Default is false.

outputDirectory

protected String outputDirectory

Directory where reports will go.

project

protected org.apache.maven.project.MavenProject project

siteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer

Constructor Detail

JsDocMojo

public JsDocMojo()

Method Detail

execute

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

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

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

Throws:

org.apache.maven.plugin.MojoExecutionException

getSiteRenderer

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

Specified by:

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

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

getOutputDirectory

protected String getOutputDirectory()

Specified by:

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

getProject

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

Specified by:

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

executeReport

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

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

getOutputName

public String getOutputName()

isExternalReport

public boolean isExternalReport()

Specified by:

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

Overrides:

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

See Also:

AbstractMavenReport.isExternalReport()