PLDoc

Description

The PLDoc Ant task generates PL/SQL code documentation using the pldoc tool.

To define task in project, add this task definition to the beginning of your build.xml file:

  <taskdef
    name="pldoc"
    classname="net.sourceforge.pldoc.ant.PLDocTask"
    classpath="pldoc.jar" />

NB: if you are using Java 1.4 or later, you'll need to override the embedded XML classes. The simplest way to do this is to define environment variable ANT_OPTS before running Ant:

  export ANT_OPTS=-Djava.endorsed.dirs=$PLDOC_HOME/xalan/bin

or on Windows:

  set ANT_OPTS=-Djava.endorsed.dirs=%PLDOC_HOME\xalan\bin

where PLDOC_HOME is the directory where pldoc is installed.

Parameters

Attribute Description Required
destdir Directory to store documentation files (created if doesn't exist). Defaults to the current directory. No
doctitle Documentation title. Defaults to MyApplication. No
overview File with overview in HTML format. No
stylesheet File with CSS-stylesheet for the result documentation. If omitted, default CSS will be used. No
namesCase Upper/lower case to format PL/SQL names (upper | lower). If omitted, no case conversion is done. No
inputEncoding Input files encoding. By default, assuming the operation system default encoding. No
exitOnError "yes" forces program exit when some input file cannot be processed. If "no" (the default), the file is skipped and processing continues. No

Parameters specified as nested elements

fileset

A FileSet. All matched files will be passed to pldoc as source files.

Example

  <pldoc
        verbose="yes"
        destdir="SampleApplicationDoc"
        doctitle="Sample Application"
        overview="samples/overview1.html">
     <fileset dir="samples" includes="sample*.sql"/>
  </pldoc>