org.codehaus.mojo.javacc

Class JJDocMojo

public class JJDocMojo extends AbstractMavenReport

JJDoc takes a JavaCC parser specification and produces documentation for the BNF grammar. This mojo will search the source directory for all *.jj files and run JJDoc once for each file it finds. Each of these output files, along with an index.html file will be placed in the site directory (target/site/jjdoc), and a link will be created in the "Project Reports" menu of the generated site.

Since: 2.3

Version: $Id: JJDocMojo.java 10603 2009-09-06 15:05:08Z bentmann $

Author: Paul Gier

See Also: JJDoc Documentation

UNKNOWN: jjdoc phase=generate-sources

Method Summary
booleancanGenerateReport()
voidexecuteReport(Locale locale)
Run the actual report.
StringgetDescription(Locale locale)
StringgetName(Locale locale)
protected StringgetOutputDirectory()
Get the output directory of the report if run directly from the command line.
StringgetOutputName()
protected MavenProjectgetProject()
Get the maven project.
protected RenderergetSiteRenderer()
Get the site renderer.

Method Detail

canGenerateReport

public boolean canGenerateReport()

Returns: true if the configured source directories are not empty, false otherwise.

See Also: org.apache.maven.reporting.MavenReport#canGenerateReport()

executeReport

public void executeReport(Locale locale)
Run the actual report.

Parameters: locale The locale to use for this report.

Throws: MavenReportException If the report generation failed.

getDescription

public String getDescription(Locale locale)

Parameters: locale The locale to use for this report.

Returns: The description of this report.

See Also: org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)

getName

public String getName(Locale locale)

Parameters: locale The locale to use for this report.

Returns: The name of this report.

See Also: org.apache.maven.reporting.MavenReport#getName(java.util.Locale)

getOutputDirectory

protected String getOutputDirectory()
Get the output directory of the report if run directly from the command line.

Returns: The report output directory.

See Also: org.apache.maven.reporting.AbstractMavenReport#getOutputDirectory()

getOutputName

public String getOutputName()

Returns: The name of the main report file.

See Also: org.apache.maven.reporting.MavenReport#getOutputName()

getProject

protected MavenProject getProject()
Get the maven project.

Returns: The current Maven project.

See Also: org.apache.maven.reporting.AbstractMavenReport#getProject()

getSiteRenderer

protected Renderer getSiteRenderer()
Get the site renderer.

Returns: The site renderer.

See Also: org.apache.maven.reporting.AbstractMavenReport#getSiteRenderer()

Copyright © 2005-2010 Codehaus. All Rights Reserved.