Template:Param2: Difference between revisions
Jump to navigation
Jump to search
Put optional parameter mark (?) after types, but before parameter name |
No edit summary |
||
Line 2: | Line 2: | ||
type|{{data|{{{name}}}|function{{{func}}}.param{{{param}}}.type}}}}{{ | type|{{data|{{{name}}}|function{{{func}}}.param{{{param}}}.type}}}}{{ | ||
#if: {{data|{{{name}}}|function{{{func}}}.param{{{param}}}.optional}} | #if: {{data|{{{name}}}|function{{{func}}}.param{{{param}}}.optional}} | ||
| <span title="This parameter is optional">?</span> | | <span style="text-decoration: underline dotted" title="This parameter is optional">?</span> | ||
}}{{ | }}{{ | ||
#ifeq: {{{format}}} | signature || {{ | #ifeq: {{{format}}} | signature || {{ |
Latest revision as of 14:13, 31 December 2020
Despite the similar name, this is completely different from [[Template:Param]].
Parameter | Description | Type | Status | |
---|---|---|---|---|
Function page name | name | Name of a function page. '''This must be a data page.''' | Page name | required |
Overloaded function number | func | A function page may describe multiple overloaded functions under the same name. This parameter allows you to select one. Allowed values are 1-5, inclusive. | Number | required |
Parameter number | param | Specify which parameter to extract. Allowed values are 1-5, inclusive. | Number | required |
Rendering format | format | "" (empty string) = show everything, "signature" = only show parameter types (i.e. function signature). Default value is empty string (show everything). | Line | optional |
Examples
Types and parameters
*"{{param2|name=visit_url|func=1|param=1}}" *"{{param2|name=visit_url|func=2|param=1}}" *"{{param2|name=visit_url|func=2|param=2}}" *"{{param2|name=visit_url|func=2|param=3}}"
Types only
*"{{param2|name=visit_url|func=1|param=1|format=signature}}" *"{{param2|name=visit_url|func=2|param=1|format=signature}}" *"{{param2|name=visit_url|func=2|param=2|format=signature}}" *"{{param2|name=visit_url|func=2|param=3|format=signature}}"