org.codehaus.mojo.javacc
Class JJDocMojo
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.codehaus.mojo.javacc.JJDocMojo
- All Implemented Interfaces:
- ContextEnabled, Mojo, MavenReport
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
- Is defined to be executed in:
- phase:
- generate-sources
- Is defined by the goal name:
- jjdoc
Fields inherited from interface org.apache.maven.plugin.Mojo |
ROLE |
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport |
closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, setReportOutputDirectory |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
JJDocMojo
public JJDocMojo()
getProject
protected MavenProject getProject()
- Get the maven project.
- Specified by:
getProject
in class AbstractMavenReport
- Returns:
- The current Maven project.
- See Also:
AbstractMavenReport.getProject()
getSiteRenderer
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
- Get the site renderer.
- Specified by:
getSiteRenderer
in class AbstractMavenReport
- Returns:
- The site renderer.
- See Also:
AbstractMavenReport.getSiteRenderer()
getOutputDirectory
protected String getOutputDirectory()
- Get the output directory of the report if run directly from the command line.
- Specified by:
getOutputDirectory
in class AbstractMavenReport
- Returns:
- The report output directory.
- See Also:
AbstractMavenReport.getOutputDirectory()
getName
public String getName(Locale locale)
- Parameters:
locale
- The locale to use for this report.
- Returns:
- The name of this report.
- See Also:
MavenReport.getName(java.util.Locale)
getDescription
public String getDescription(Locale locale)
- Parameters:
locale
- The locale to use for this report.
- Returns:
- The description of this report.
- See Also:
MavenReport.getDescription(java.util.Locale)
getOutputName
public String getOutputName()
- Returns:
- The name of the main report file.
- See Also:
MavenReport.getOutputName()
canGenerateReport
public boolean canGenerateReport()
- Specified by:
canGenerateReport
in interface MavenReport
- Overrides:
canGenerateReport
in class AbstractMavenReport
- Returns:
true
if the configured source directories are not empty, false
otherwise.- See Also:
MavenReport.canGenerateReport()
executeReport
public void executeReport(Locale locale)
throws MavenReportException
- Run the actual report.
- Specified by:
executeReport
in class AbstractMavenReport
- Parameters:
locale
- The locale to use for this report.
- Throws:
MavenReportException
- If the report generation failed.
Copyright © 2005-2012 Codehaus. All Rights Reserved.