Parameter/Documentation

Description

Displays a documentation parameter. Used to ensure documentation is standardised.

Parameters

Arrow.png1: The name of the parameter.
Required.
Arrow.png2: A concise description of the parameter.
Required.
Arrow.png3: The default value of the parameter.
Optional.
Notes: If there is no default value, the parameter is assumed to be required. If the parameter is optional and has no default value, define the parameter but leave it blank.
Arrow.png3: Additional notes.
Optional.

Usage

{{parameter|name|description}}
{{parameter|name|description|default}}
{{parameter|name|description|default|notes}}