Parameter and Return Value Descriptions

Describing functions, you might want to describe the purpose of each parameter separately. Doc-O-Matic supports by-parameter descriptions in the Parameter Section of a topic and return value descriptions in the Return Value Section (default starters: Return Value List, Return Value Details).

In addition you can use the predefined variables PAR0, PAR1, PAR2, PAR3 instead of using the parameter name. The variables expand to the name of the n-th parameter. If you change a parameter name in the declaration of the function the parameter names and their descriptions are automatically updated.

Notes

Avoid character formatting in parameter names and values. Doc-O-Matic can not process character formatting in parameter names and values.

Parameter Description Overview

There are several ways to describe parameters.

Your way of describing parameters	Doc-O-Matic Option
Using parameter names only.	Simple - turned on by default
Using a declaration like syntax beginning with the parameter name	First Word
Using a declaration like syntax ending with the parameter name	Last Word
Describing parameters in parameter lists located following the parameter location (description in parameter lists are only exported, if there does not exist a parameter section in the same topic)	Parameter list inline comments - turned on by default

Note: Using the options First Word or Last Word you can still document parameters using their names only.

Additional Information

Simple Example
Last Word Example
Parameter List Example
First Word Example
Return Value and Value Descriptions Example

Related Settings

Parameter Description, Comment Style, Section Delimiter