public class JJDocMojo
extends org.apache.maven.reporting.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.Constructor and Description |
---|
JJDocMojo() |
Modifier and Type | Method and Description |
---|---|
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 org.apache.maven.project.MavenProject |
getProject()
Get the maven project.
|
protected org.apache.maven.doxia.siterenderer.Renderer |
getSiteRenderer()
Get the site renderer.
|
closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, setReportOutputDirectory
protected org.apache.maven.project.MavenProject getProject()
getProject
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.getProject()
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
getSiteRenderer
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.getSiteRenderer()
protected String getOutputDirectory()
getOutputDirectory
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.getOutputDirectory()
public String getName(Locale locale)
locale
- The locale to use for this report.MavenReport.getName(java.util.Locale)
public String getDescription(Locale locale)
locale
- The locale to use for this report.MavenReport.getDescription(java.util.Locale)
public String getOutputName()
MavenReport.getOutputName()
public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
canGenerateReport
in class org.apache.maven.reporting.AbstractMavenReport
true
if the configured source directories are not empty, false
otherwise.MavenReport.canGenerateReport()
public void executeReport(Locale locale) throws org.apache.maven.reporting.MavenReportException
executeReport
in class org.apache.maven.reporting.AbstractMavenReport
locale
- The locale to use for this report.org.apache.maven.reporting.MavenReportException
- If the report generation failed.Copyright © 2005–2018 MojoHaus. All rights reserved.