Parameter/Documentation

Description

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

Usage

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

Parameters

1: The name of the parameter.

Required.

2: A concise description of the parameter.

Required.

3: 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.

3: Additional notes.

Optional.

Errors

No parameter description was provided. Add a description parameter.
No parameter name was provided. Add a name parameter.