svc-helpdoc

The svc-helpdoc task generates Groovy service help documentation.

Task Structure

The structure of the svc-helpdoc task element is shown below.

<svc-helpdoc srcDir=... >
    <fileset dir=... >
        <include name=... />
    </fileset>
</svc-helpdoc>

The fileset element is an Ant FileSet. For detailed information, see FileSet Type - Apache Ant.

Task Attributes

All attributes are optional unless otherwise indicated.

The svc-helpdoc element recognises the following attributes.

Attribute	Description
srcDir	String Required. The source directory.

The fileset element recognises the following attributes.

Attribute	Description
dir	String Required. A directory containing service definition JSON files.

The include element recognises the following attributes.

Attribute	Description
name	String Required. A file name or file mask identifying service definition JSON files. The service definition files are located in the directory specified by the dir attribute of the containing fileset element.

Example

The example Ant task below scans and fills some of the file includes automatically for multiple service definitions as specified by the fileset element.

<svc-helpdoc  srcDir="${svc.src.dir}">
    <fileset dir="src">
        <include name="**/service-def.json"/>
    </fileset>
</svc-helpdoc>