Parameter/Documentation

Description[edit]

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

Usage[edit]

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

Parameters[edit]

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.

Errors[edit]

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