net.sourceforge.pldoc.mojo
Class PLDoc
java.lang.Object
org.apache.maven.plugin.AbstractMojo
net.sourceforge.pldoc.mojo.PLDoc
- All Implemented Interfaces:
- org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport
public class PLDoc
- extends org.apache.maven.plugin.AbstractMojo
- implements org.apache.maven.reporting.MavenReport
Goal which touches a timestamp file.
Here i a sample configuration for the plugin with the defaults:
net.sourceforge.pldoc
maven-pldoc-plugin
2.1-SNAPSHOT
project-name
src/sql
*.sql
target/site/apidocs
true
jdbc:oracle:thin:@//192.168.100.22:1521/orcl
system
oracle
PROCEDURE,FUNCTION,TRIGGER,PACKAGE,TYPE,PACKAGE BODY,TYPE BODY
ANONYMOUS.%,APEX_040000.%,APEX_PUBLIC_USER.%,APPQOSSYS.%,BI.%,CACHEADM.%,CTXSYS.%,DBSNMP.%,DEMO.%,DIP.%,EXFSYS.%,FLOWS_FILES.%,HR.%,HR1.%,HR_TRIG.%,IX.%,MDDATA.%,MDSYS.%,MGMT_VIEW.%,OBE.%,OE.%,OE1.%,OLAPSYS.%,ORACLE_OCM.%,ORDDATA.%,ORDPLUGINS.%,ORDSYS.%,OUTLN.%,OWBSYS.%,OWBSYS_AUDIT.%,PHPDEMO.%,PLS.%,PM.%,SCOTT.%,SH.%,SI_INFORMTN_SCHEMA.%,SPATIAL_CSW_ADMIN_USR.%,SPATIAL_WFS_ADMIN_USR.%,SYS.%,SYSMAN.%,SYSTEM.%,TIMESTEN.%,TTHR.%,WMSYS.%,XDB.%,XDBMETADATA.%,XDBPM.%,XFILES.%,XS$NULL.%
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()
|
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 |
outputDirectory
protected File outputDirectory
- Specifies the destination directory where pldoc saves the generated HTML files.
PLDoc
public PLDoc()
execute
public void execute()
throws org.apache.maven.plugin.MojoExecutionException
- Specified by:
execute
in interface org.apache.maven.plugin.Mojo
- Throws:
org.apache.maven.plugin.MojoExecutionException
generate
public void generate(org.codehaus.doxia.sink.Sink arg0,
Locale arg1)
throws org.apache.maven.reporting.MavenReportException
- Specified by:
generate
in interface org.apache.maven.reporting.MavenReport
- Throws:
org.apache.maven.reporting.MavenReportException
getOutputName
public String getOutputName()
- Specified by:
getOutputName
in interface org.apache.maven.reporting.MavenReport
getName
public String getName(Locale locale)
- Specified by:
getName
in interface org.apache.maven.reporting.MavenReport
getCategoryName
public String getCategoryName()
- Specified by:
getCategoryName
in interface org.apache.maven.reporting.MavenReport
getDescription
public String getDescription(Locale locale)
- Specified by:
getDescription
in interface org.apache.maven.reporting.MavenReport
setReportOutputDirectory
public void setReportOutputDirectory(File reportOutputDirectory)
- Specified by:
setReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
getReportOutputDirectory
public File getReportOutputDirectory()
- Specified by:
getReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
isExternalReport
public boolean isExternalReport()
- Specified by:
isExternalReport
in interface org.apache.maven.reporting.MavenReport
canGenerateReport
public boolean canGenerateReport()
- Specified by:
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
Copyright © 2011. All Rights Reserved.