org.codehaus.mojo.javacc
public class JJDocMojo extends AbstractMavenReport
*.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 $
See Also: JJDoc Documentation
UNKNOWN: jjdoc phase=generate-sources
Method Summary | |
---|---|
boolean | canGenerateReport() |
void | executeReport(Locale locale)
Run the actual report.
|
String | getDescription(Locale locale) |
String | getName(Locale locale) |
protected String | getOutputDirectory()
Get the output directory of the report if run directly from the command line.
|
String | getOutputName() |
protected MavenProject | getProject()
Get the maven project.
|
protected Renderer | getSiteRenderer()
Get the site renderer.
|
Returns: true
if the configured source directories are not empty, false
otherwise.
See Also: org.apache.maven.reporting.MavenReport#canGenerateReport()
Parameters: locale The locale to use for this report.
Throws: MavenReportException If the report generation failed.
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)
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)
Returns: The report output directory.
See Also: org.apache.maven.reporting.AbstractMavenReport#getOutputDirectory()
Returns: The name of the main report file.
See Also: org.apache.maven.reporting.MavenReport#getOutputName()
Returns: The current Maven project.
See Also: org.apache.maven.reporting.AbstractMavenReport#getProject()
Returns: The site renderer.
See Also: org.apache.maven.reporting.AbstractMavenReport#getSiteRenderer()