Difference between revisions of "Parameter/Documentation"
Stratonian (talk | contribs) m (→Errors) |
Stratonian (talk | contribs) m |
||
| Line 1: | Line 1: | ||
==Description== | ==Description== | ||
Displays a documentation parameter. Used to ensure documentation is standardised. | Displays a documentation parameter. Used to ensure documentation is standardised. | ||
| + | ==Usage== | ||
| + | {{T|parameter|name|description}} | ||
| + | {{T|parameter|name|description|default}} | ||
| + | {{T|parameter|name|description|default|notes}} | ||
==Parameters== | ==Parameters== | ||
{{parameter|1|The name of the parameter.}} | {{parameter|1|The name of the parameter.}} | ||
| Line 6: | Line 10: | ||
{{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.|}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Errors== | ==Errors== | ||
'''No parameter description was provided. Add a description parameter.'''<br> | '''No parameter description was provided. Add a description parameter.'''<br> | ||
'''No parameter name was provided. Add a name parameter.''' | '''No parameter name was provided. Add a name parameter.''' | ||
Revision as of 20:09, 25 February 2023
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.