Difference between revisions of "Parameter"
Stratonian (talk | contribs) m (added <code> and <nowiki> tags to the default) |
Stratonian (talk | contribs) m (different quote marks) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 2: | Line 2: | ||
|;{{arrow}}'''{{{1}}}'''<nowiki>:</nowiki> {{{2|{{error|No parameter description was provided. Add a description parameter.}}}}}<!-- handle parameter name and description | |;{{arrow}}'''{{{1}}}'''<nowiki>:</nowiki> {{{2|{{error|No parameter description was provided. Add a description parameter.}}}}}<!-- handle parameter name and description | ||
-->:{{#ifeq:{{{3|}}}|{{{3}}}|Optional|Required}}.<!-- handle whether parameter is required | -->:{{#ifeq:{{{3|}}}|{{{3}}}|Optional|Required}}.<!-- handle whether parameter is required | ||
| − | -->{{#if:{{{3|}}}| Defaults to | + | -->{{#if:{{{3|}}}| Defaults to '<code>{{{3}}}</code>'.}}<!-- handle parameter default |
-->{{#if:{{{4|}}}|:'''Notes''': {{{4}}}}}<!-- handle parameter notes | -->{{#if:{{{4|}}}|:'''Notes''': {{{4}}}}}<!-- handle parameter notes | ||
-->|{{error|No parameter name was provided. Add a name parameter.}}}}<!-- error if no name | -->|{{error|No parameter name was provided. Add a name parameter.}}}}<!-- error if no name | ||
--></includeonly><noinclude>{{Parameter/Documentation}}</noinclude> | --></includeonly><noinclude>{{Parameter/Documentation}}</noinclude> | ||
Latest revision as of 19:14, 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.