XMLDocumentation

Description

Generate Progress Developer Studio (aka OpenEdge Architect) documentation from XML files, generated by ClassDocumentation task. This documentation is meant to be read using the Class Browser Documentation view.

Read requirements here (slides 41 to 45) or directly on XMLDocumentationRequirements.

XML namespace

<pct:xmldocumentation />

Requirements

This task only works under Windows environment, and is not compatible with OpenEdge 10. The 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="extras.properties" />

Parameters

Attribute	Description	Default value
sourceDir ‡	Directory where XML files are located	No default value
destFile ‡	Directory where XML output file is written	No default value

† Only one of those attributes is mandatory ‡ Mandatory attribute

XMLDocumentation inherits attributes from PCT.

Parameters as nested elements

None

Examples

<PCTCompile destDir="build" preprocessDir="preprocess" dlcHome="${DLC}">
  <fileset dir="src" includes="**/*.cls" />
  <propath>
    <pathelement path="src"/>
  </propath>
</PCTCompile>
<ClassDocumentation destDir="doc" dlcHome="${DLC}">
  <fileset dir="preprocess" includes="**/*.cls" />
</ClassDocumentation>
<XMLDocumentation sourceDir="doc" destFile="project.xml" dlcHome="${DLC}" />

Compiles every .cls in src directory (and subdirs) in build directory, generates preprocessed classes in preprocess directory, then generates XML documentation from the preprocessed classes, and then generates XML documentation for Class Browser.