Difference between revisions of "Parameter/Documentation"
Stratonian (talk | contribs) m |
Stratonian (talk | contribs) m (Categorized) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
==Description== | ==Description== | ||
| − | Displays a documentation parameter. Used to ensure documentation is | + | Displays a documentation parameter. Used to ensure documentation is standardized. |
| + | |||
| + | ==Usage== | ||
| + | {{T|parameter|name|description}}<br> | ||
| + | {{T|parameter|name|description|default}}<br> | ||
| + | {{T|parameter|name|description|default|notes}}<br> | ||
| + | {{T|parameter|name|description|4{{=}}notes}} | ||
| + | |||
==Parameters== | ==Parameters== | ||
{{parameter|1|The name of the parameter.}} | {{parameter|1|The name of the parameter.}} | ||
| Line 6: | Line 13: | ||
{{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.''' | + | '''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.''' | ||
| + | <includeonly>[[Category:General Wiki Templates]]</includeonly> | ||
Latest revision as of 18:57, 19 August 2023
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]
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[edit]
No parameter description was provided. Add a description parameter.
No parameter name was provided. Add a name parameter.