|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.codehaus.mojo.aspectj.AjcReportMojo
public class AjcReportMojo
Creates a ajdoc report in html format.
Field Summary | |
---|---|
protected String |
ajdtBuildDefFile
Where to find the ajdt build definition file. |
protected String |
aspectDirectory
The source directory for the aspects |
protected File |
basedir
The basedir of the project. |
protected String |
complianceLevel
Specify compiler compliance setting (1.3 to 1.5, default is 1.4) |
protected String |
doctitle
Specifies the title to be placed near the top of the overview summary file. |
protected String[] |
excludes
List of ant-style patterns used to specify the aspects that should be excluded when compiling. |
protected String[] |
includes
List of ant-style patterns used to specify the aspects that should be included when compiling. |
protected String |
overview
Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html). |
protected boolean |
packageScope
Shows only package, protected, and public classes and members. |
protected boolean |
privateScope
Shows all classes and members. |
protected org.apache.maven.project.MavenProject |
project
The maven project. |
protected boolean |
protectedScope
Shows only protected and public classes and members. |
protected boolean |
publicScope
Shows only public classes and members. |
protected String |
testAspectDirectory
The source directory for the test aspects |
protected boolean |
verbose
Provides more detailed messages while javadoc is running. |
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 | |
---|---|
AjcReportMojo()
|
Method Summary | |
---|---|
boolean |
canGenerateReport()
|
protected void |
executeReport(Locale locale)
Executes this ajdoc-report generation. |
String |
getDescription(Locale locale)
|
String |
getName(Locale locale)
|
protected List |
getOutputDirectories()
get compileroutput directory. |
protected String |
getOutputDirectory()
get report output directory. |
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. |
protected List |
getSourceDirectories()
Get the directories containg sources |
boolean |
isExternalReport()
|
void |
setComplianceLevel(String complianceLevel)
Setters which when called sets compiler arguments |
void |
setDoctitle(String doctitle)
|
void |
setOverview(String overview)
|
void |
setPackageScope(boolean packageScope)
|
void |
setPluginArtifacts(List pluginArtifacts)
|
void |
setPrivateScope(boolean privateScope)
|
void |
setProtectedScope(boolean protectedScope)
|
void |
setPublicScope(boolean publicScope)
|
void |
setVerbose(boolean verbose)
|
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport |
---|
closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, 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 |
---|
protected String aspectDirectory
protected String testAspectDirectory
protected org.apache.maven.project.MavenProject project
protected File basedir
protected String[] includes
protected String[] excludes
protected String ajdtBuildDefFile
protected boolean packageScope
protected boolean protectedScope
protected boolean privateScope
protected boolean publicScope
protected String overview
protected String doctitle
protected boolean verbose
protected String complianceLevel
Constructor Detail |
---|
public AjcReportMojo()
Method Detail |
---|
protected void executeReport(Locale locale) throws org.apache.maven.reporting.MavenReportException
executeReport
in class org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.reporting.MavenReportException
protected List getSourceDirectories()
protected String getOutputDirectory()
getOutputDirectory
in class org.apache.maven.reporting.AbstractMavenReport
protected List getOutputDirectories()
public String getOutputName()
public String getName(Locale locale)
public String getDescription(Locale locale)
public boolean isExternalReport()
isExternalReport
in interface org.apache.maven.reporting.MavenReport
isExternalReport
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.isExternalReport()
public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
canGenerateReport
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.canGenerateReport()
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
getSiteRenderer
in class org.apache.maven.reporting.AbstractMavenReport
protected org.apache.maven.project.MavenProject getProject()
getProject
in class org.apache.maven.reporting.AbstractMavenReport
public void setOverview(String overview)
public void setDoctitle(String doctitle)
public void setPackageScope(boolean packageScope)
public void setPrivateScope(boolean privateScope)
public void setProtectedScope(boolean protectedScope)
public void setPublicScope(boolean publicScope)
public void setVerbose(boolean verbose)
public void setComplianceLevel(String complianceLevel)
public void setPluginArtifacts(List pluginArtifacts)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |