Template:Function2: Difference between revisions
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
<includeonly>{{TOCright}}{{DISPLAYTITLE:{{{name}}}()}}{{#if: {{{needscode|}}}|{{CodeRequest}}}}{{#if: {{{improvecode|}}}|{{CodeRequest|better=yes}}}} | <includeonly>{{TOCright}}{{DISPLAYTITLE:{{{name}}}()}}{{#if: {{{needscode|}}}|{{CodeRequest}}}}{{#if: {{{improvecode|}}}|{{CodeRequest|better=yes}}}} | ||
{{#if: {{{name|}}}|{{error|Parameter 'name' is missing for User:Philmasterplus/TemplateSandbox2}}}} | {{#if: {{{name|}}}||{{error|Parameter 'name' is missing for User:Philmasterplus/TemplateSandbox2}}}} | ||
==Function Syntax== | ==Function Syntax== | ||
{{#if: {{{function1.return_type|}}} | {{#if: {{{function1.return_type|}}} |
Revision as of 15:38, 18 December 2020
Replacement for Template:FunctionPage. Must be used with function pages that follow a specific format.
Parameter | Description | Type | Status | |
---|---|---|---|---|
ASH function name | name | Name of the ASH function. This should match the function page name.
| Line | required |
Function 1, short description | function1.short_description | Short description for the 1st overloaded form of the function
| Content | optional |
Function 1, return type | function1.return_type | Return type of the 1st overloaded form of the function.
| Line | required |
Function 1, parameter 1 | function1.parameter1 | Name of the parameter 1 of the 1st overloaded form of the function.
| Line | optional |
Function 1, parameter 1 description | function1.parameter1.description | Description of parameter 1 of the 1st overloaded form of the function.
| Content | optional |
Function 1, parameter 1 is optional? | function1.parameter1.optional | Whether parameter 1 of the 1st overloaded form of the function is optional. Note that ASH does not support truly optional parameters; a function with optional parameters is actually multiple overloaded functions.
| Boolean | optional |
Function 1, parameter 1 default value | function1.parameter1.default | The default value of parameter 1 of the 1st overloaded form of the function. This should be used in conjunction with function1.parameter1.optional
| Line | optional |