public class PLDocTask
extends org.apache.tools.ant.Task
To define task in project:
<taskdef name="pldoc" classname="net.sourceforge.pldoc.ant.PLDocTask" classpath="pldoc.jar" />
To use:
<pldoc verbose = "yes" | "no" (default: "no") doctitle = text stylesheet = text sourcestylesheet = text destdir = dir-path overview = file-path namesCase = "upper" | "lower" | "mixed" | "default" inputEncoding = encoding (default: OS dependant) > ignoreInformalComments = (false | true) showSkippedPackages = (false | true) plscope = (false | true) saveSourceCode = (false | true) url = text user = text password = text types = text sql = text <!-- fileset+ --> </pldoc> driverName = text getMetadataStatement = text returntype = integer
Where:
Modifier and Type | Class and Description |
---|---|
static class |
PLDocTask.NamesCase |
Constructor and Description |
---|
PLDocTask() |
Modifier and Type | Method and Description |
---|---|
void |
addFileset(org.apache.tools.ant.types.FileSet fset) |
void |
execute() |
void |
setDbPassword(String dbPassword) |
void |
setDbUrl(String dbUrl) |
void |
setDbUser(String dbUser) |
void |
setDestdir(File dir) |
void |
setDoctitle(String doctitle) |
void |
setDriverName(String driverName) |
void |
setExitOnError(boolean exitOnError) |
void |
setGetMetadataStatement(String getMetadataStatement) |
void |
setIgnoreInformalComments(boolean ignoreInformalComments) |
void |
setInputEncoding(String enc) |
void |
setInputObjects(String inputObjects) |
void |
setInputTypes(String inputTypes) |
void |
setNamesCase(PLDocTask.NamesCase namesCase) |
void |
setOverview(File file) |
void |
setPlscope(boolean plscope) |
void |
setReturnType(Integer getMetadataStatementReturnType) |
void |
setSaveSourceCode(boolean savesourcecode) |
void |
setShowSkippedPackages(boolean showSkippedPackages) |
void |
setSourceStylesheet(String sourcestylesheet) |
void |
setStylesheet(String stylesheet) |
void |
setVerbose(boolean verbose) |
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
public void setVerbose(boolean verbose)
public void setDestdir(File dir)
public void setDoctitle(String doctitle)
public void setStylesheet(String stylesheet)
public void setSourceStylesheet(String sourcestylesheet)
public void setOverview(File file)
public void addFileset(org.apache.tools.ant.types.FileSet fset)
public void setInputEncoding(String enc)
public void setExitOnError(boolean exitOnError)
public void setDbUrl(String dbUrl)
public void setDbUser(String dbUser)
public void setDbPassword(String dbPassword)
public void setInputObjects(String inputObjects)
public void setInputTypes(String inputTypes)
public void setShowSkippedPackages(boolean showSkippedPackages)
public void setPlscope(boolean plscope)
public void setSaveSourceCode(boolean savesourcecode)
public void setIgnoreInformalComments(boolean ignoreInformalComments)
public void setDriverName(String driverName)
public void setGetMetadataStatement(String getMetadataStatement)
public void setReturnType(Integer getMetadataStatementReturnType)
public void setNamesCase(PLDocTask.NamesCase namesCase)
public void execute() throws org.apache.tools.ant.BuildException
execute
in class org.apache.tools.ant.Task
org.apache.tools.ant.BuildException
Copyright © 2019. All rights reserved.