Difference between revisions of "Parameter/Documentation"
Stratonian (talk | contribs) (Created page with "==Description== Displays a documentation parameter. Used to ensure documentation is standardised. ==Parameters== {{parameter|1|The name of the parameter.}} {{parameter|2|A con...") |
Stratonian (talk | contribs) m |
||
Line 6: | Line 6: | ||
{{parameter|3|The default value of the parameter.||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.}} | {{parameter|3|The default value of the parameter.||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.}} | ||
{{parameter|3|Additional notes.|}} | {{parameter|3|Additional notes.|}} | ||
− | |||
==Usage== | ==Usage== | ||
<pre> | <pre> |
Revision as of 17:11, 25 February 2023
Description
Displays a documentation parameter. Used to ensure documentation is standardised.
Parameters
- 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.
Usage
{{parameter|name|description}} {{parameter|name|description|default}} {{parameter|name|description|default|notes}}