Difference between revisions of "Parameter/Documentation"
Stratonian (talk | contribs) m (→Usage) |
Stratonian (talk | contribs) m (→Description: american english) |
||
| 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== | ==Usage== | ||
{{T|parameter|name|description}}<br> | {{T|parameter|name|description}}<br> | ||
Revision as of 19:35, 2 March 2023
Description
Displays a documentation parameter. Used to ensure documentation is standardized.
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.