ClassDocumentation
Generate XML documentation from OpenEdge classes. An example of generated documentation is available here (full documentation for OpenEdge.DataAdmin package is available here).
Comments have to be written using a specific syntax to be parsed correctly.
<pct:classdocumentation />
This task requires JAR files ast.jar and ast-dependencies.jar in your classpath. You can find them:
- In
%DLC%\java\ant-libs(OpenEdge 11.7 and 12.0) - In
%DLC%\oeide\eclipse\plugins\com.progress.openedge.pdt.abldoc.core_11.5.1.00\lib(OpenEdge 11.5 and 11.6). You'll need a Progress Developer Studio licence to have those files installed.
Drop the JAR files in ${ANT_HOME}/lib or call Ant with -lib /path/to/ast.jar -lib /path/to/ast-dependencies.jar.
Task isn't declared in the same .properties file as the other tasks. You'll need to add this line to your build.xml :
<taskdef resource="extras115.properties" />It's recommended to generate documentation from preprocessed source. Use preprocessDir attribute of PCTCompile task to generate preprocessed classes, then use ClassDocumentation on this directory.
| Attribute | Description | Default value |
|---|---|---|
| destDir ‡ | Directory where to put XML files | No default value |
| encoding | Use specified encoding when reading source files. Not yet implemented | No default value |
† Only one of those attributes is mandatory ‡ Mandatory attribute
ClassDocumentation inherits attributes from PCT.
Adds a file set
<PCTCompile destDir="build" preprocessDir="preprocess" dlcHome="${DLC}">
<fileset dir="src" includes="**/*.cls" />
<propath path="src" />
</PCTCompile>
<ClassDocumentation destDir="doc" dlcHome="${DLC}">
<fileset dir="preprocess" includes="**/*.cls" />
<propath path="preprocess" />
</ClassDocumentation>Compiles every .cls in src directory (and subdirs) in build directory, generates preprocessed classes in preprocess directory, then generate XML documentation from the preprocessed classes.
