|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
net.sourceforge.pldoc.mojo.PLDoc
public class PLDoc
Goal which touches a timestamp file.
Here is a sample configuration for the plugin with the defaults:
| Field Summary | |
|---|---|
protected File |
outputDirectory
Specifies the destination directory where pldoc saves the generated HTML files. |
| 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 | |
|---|---|
PLDoc()
|
|
| Method Summary | |
|---|---|
boolean |
canGenerateReport()
|
void |
execute()
|
void |
generate(org.codehaus.doxia.sink.Sink sink,
Locale locale)
This implementation current ignore ignores both parameters |
String |
getCategoryName()
|
String |
getDescription(Locale locale)
|
String |
getName(Locale locale)
|
String |
getOutputName()
|
File |
getReportOutputDirectory()
|
boolean |
isExternalReport()
|
void |
setDestDir(String destDir)
|
void |
setReportOutputDirectory(File reportOutputDirectory)
|
| 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 File outputDirectory
| Constructor Detail |
|---|
public PLDoc()
| Method Detail |
|---|
public void execute()
throws org.apache.maven.plugin.MojoExecutionException
execute in interface org.apache.maven.plugin.Mojoorg.apache.maven.plugin.MojoExecutionException
public void generate(org.codehaus.doxia.sink.Sink sink,
Locale locale)
throws org.apache.maven.reporting.MavenReportException
generate in interface org.apache.maven.reporting.MavenReportorg.apache.maven.reporting.MavenReportExceptionpublic String getOutputName()
getOutputName in interface org.apache.maven.reporting.MavenReportpublic String getName(Locale locale)
getName in interface org.apache.maven.reporting.MavenReportpublic String getCategoryName()
getCategoryName in interface org.apache.maven.reporting.MavenReportpublic String getDescription(Locale locale)
getDescription in interface org.apache.maven.reporting.MavenReportpublic void setDestDir(String destDir)
public void setReportOutputDirectory(File reportOutputDirectory)
setReportOutputDirectory in interface org.apache.maven.reporting.MavenReportpublic File getReportOutputDirectory()
getReportOutputDirectory in interface org.apache.maven.reporting.MavenReportpublic boolean isExternalReport()
isExternalReport in interface org.apache.maven.reporting.MavenReportpublic boolean canGenerateReport()
canGenerateReport in interface org.apache.maven.reporting.MavenReport
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||