Documentation generator

Configuration documentation generator (ConfigDoc) is a utility and Ant task which generates HTML documentation for Configurator files.

• outputDir - Output directory.
• source - URL of configuration file to document.

• path - Semicolon-separated list of classpath entries. Entries shall be URL's, e.g. file:mylib.jar or http://myserver/myjar.jar

Below is a fragment of Hammurapi Rules Tutorial build file which generates HTML documentation for the inspector set:

build.xml

<taskdef name="configdoc" classname="com.hammurapi.config.runtime.ConfigDoc">
	<classpath>
		<fileset dir="lib" includes="*.jar"/>
	</classpath>
</taskdef>
 
<delete failonerror="false">
	<fileset dir="doc/ruleset"/>
</delete>
 
<configdoc source="${basedir}\familyties.hrules" outputdir="doc/ruleset"/>

Class name: com.hammurapi.config.runtime.ConfigDoc Parameters:

• source file
• output directory

Example:

java [options] com.hammurapi.config.runtime.ConfigDoc myconfig.hgconfig config-doc