public class PLDoc
extends org.apache.maven.plugin.AbstractMojo
implements org.apache.maven.reporting.MavenReport
Modifier and Type | Field and Description |
---|---|
protected File |
outputDirectory
Specifies the destination directory where pldoc saves the generated HTML files.
|
protected File |
overviewFile
Specifies the File summarising the documented application.
|
Constructor and Description |
---|
PLDoc() |
Modifier and Type | Method and Description |
---|---|
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) |
protected File overviewFile
protected File outputDirectory
public void execute() throws org.apache.maven.plugin.MojoExecutionException
execute
in interface org.apache.maven.plugin.Mojo
org.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.MavenReport
org.apache.maven.reporting.MavenReportException
public String getOutputName()
getOutputName
in interface org.apache.maven.reporting.MavenReport
public String getName(Locale locale)
getName
in interface org.apache.maven.reporting.MavenReport
public String getCategoryName()
getCategoryName
in interface org.apache.maven.reporting.MavenReport
public String getDescription(Locale locale)
getDescription
in interface org.apache.maven.reporting.MavenReport
public void setDestDir(String destDir)
public void setReportOutputDirectory(File reportOutputDirectory)
setReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
public File getReportOutputDirectory()
getReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
public boolean isExternalReport()
isExternalReport
in interface org.apache.maven.reporting.MavenReport
public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
Copyright © 2014. All Rights Reserved.