User Documentation

The workbench provides a quick and simple way for users to document their code. Specifically DEFSUBs.

By using the keyboard shortcut Ctrl-Shift-D when the cursor is on a DEFSUB declaration we bring up the following dialog. The dialog is used for entering documentation.

Documentation dialog box:

Documentation dialog

It allows you to enter brief and detailed descriptions. It also allows you to document each parameter.

XML Data Island

The help information is stored in the source as an XML data island. The workbench hides this from the user.

Below is an example of such a data island.

<xmlData type='help' subtype='embedded'>
        <brief>TODO</brief>
        <detailed>TODO</detailed>
        <args>
                <param name='min' flag='in'>TODO</param>
                <param name='max' flag='in'>TODO</param>
                <param name='memp' flag='in'>TODO</param>
        </args>
        <return>TODO</return>
</xmlData>

XML tags

Tag Level Purpose
xmlData 0 Root node. Attributes should be fixed as above.
brief 1 Brief description. A very short description to be used in tooltips, that gives the user a basic overview of functionality.
detailed 1 Detailed description. A detailed description of the functionality and how the function implements this functionality.
args 1 Collection of parameters.
param 2
Attribute Purpose
name Parameter name as it appears in DEFSUB line.
flag Flags used to mark the parameter. "in", "out", "both", and "unused".
return 1 Return description. Description of the return type, expected returns for given input.