JsonDocumentation

Description

Generate JSON documentation from OpenEdge classes. Comments have to be written using a specific syntax to be parsed correctly. This task also requires access to rcode.

XML namespace

<pct:json_doc />

Parameters

Attribute	Description	Default value
destFile ‡	JSON file output	No default value
buildDir ‡	Directory where rcode will be read	No default value
encoding	Use specified encoding when reading source files	No default value
style	Comment style: Javadoc (/**), simple (/*), consultingwerk (/*-)	Javadoc
indent	JSON pretty-printing	False

† Only one of those attributes is mandatory ‡ Mandatory attribute

ClassDocumentation inherits attributes from PCT.

Parameters as nested elements

fileset

Source classes to include in JSON documentation. Standard Ant fileset

propath

Standard Ant path structure

DBConnection and DBConnectionSet

Database connections.

Examples

Example 1

<JsonDocumentation buildDir="build" destFile="doc/out.json" dlcHome="${DLC}" encoding="iso-8859-1" indent="true">
  <fileset dir="src" includes="**/*.cls" />
  <DBConnection dbName="sports2000" dbDir="target/db" singleUser="true" />
  <propath>
    <pathelement location="src" />
    <pathelement location="${DLC}/tty/netlib/OpenEdge.Net.pl" />
  </propath>
</JsonDocumentation>

Creates documentation of all .cls files in the src directory. RCode is expected to be found in the build (using PCTCompile).