Template:Function2: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 15: | Line 15: | ||
|<li>'''{{{function1.parameter2.type}}} {{Pspan|{{{function1.parameter2}}}}}''': {{{function1.parameter2.description}}}</li>}} | |<li>'''{{{function1.parameter2.type}}} {{Pspan|{{{function1.parameter2}}}}}''': {{{function1.parameter2.description}}}</li>}} | ||
{{#if: {{{function1.parameter3|}}} | {{#if: {{{function1.parameter3|}}} | ||
|<li>'''{{{function1.parameter3.type}}} {{Pspan|{{{function1.parameter3}}}}}''': {{{function1.parameter3.description}}}</li></ul>}} | |<li>'''{{{function1.parameter3.type}}} {{Pspan|{{{function1.parameter3}}}}}''': {{{function1.parameter3.description}}}</li>}} | ||
{{#if: {{{function1.parameter1|}}}|</ul>}} | |||
{{#if: {{{function1.short_description|}}}|: {{{function1.short_description}}}}} | {{#if: {{{function1.short_description|}}}|: {{{function1.short_description}}}}} | ||
}}{{#if: {{{function2.return_type|}}} | }}{{#if: {{{function2.return_type|}}} | ||
| Line 30: | Line 31: | ||
|<li>'''{{{function2.parameter2.type}}} {{Pspan|{{{function2.parameter2}}}}}''': {{{function2.parameter2.description}}}</li>}} | |<li>'''{{{function2.parameter2.type}}} {{Pspan|{{{function2.parameter2}}}}}''': {{{function2.parameter2.description}}}</li>}} | ||
{{#if: {{{function2.parameter3|}}} | {{#if: {{{function2.parameter3|}}} | ||
|<li>'''{{{function2.parameter3.type}}} {{Pspan|{{{function2.parameter3}}}}}''': {{{function2.parameter3.description}}}</li></ul>}} | |<li>'''{{{function2.parameter3.type}}} {{Pspan|{{{function2.parameter3}}}}}''': {{{function2.parameter3.description}}}</li>}} | ||
{{#if: {{{function2.parameter1|}}}|</ul>}} | |||
{{#if: {{{function2.short_description|}}}|: {{{function2.short_description}}}}} | {{#if: {{{function2.short_description|}}}|: {{{function2.short_description}}}}} | ||
}}{{#if: {{{function3.return_type|}}} | }}{{#if: {{{function3.return_type|}}} | ||
| Line 45: | Line 47: | ||
|<li>'''{{{function3.parameter2.type}}} {{Pspan|{{{function3.parameter2}}}}}''': {{{function3.parameter2.description}}}</li>}} | |<li>'''{{{function3.parameter2.type}}} {{Pspan|{{{function3.parameter2}}}}}''': {{{function3.parameter2.description}}}</li>}} | ||
{{#if: {{{function3.parameter3|}}} | {{#if: {{{function3.parameter3|}}} | ||
|<li>'''{{{function3.parameter3.type}}} {{Pspan|{{{function3.parameter3}}}}}''': {{{function3.parameter3.description}}}</li></ul>}} | |<li>'''{{{function3.parameter3.type}}} {{Pspan|{{{function3.parameter3}}}}}''': {{{function3.parameter3.description}}}</li>}} | ||
{{#if: {{{function3.parameter1|}}}|</ul>}} | |||
{{#if: {{{function3.short_description|}}}|: {{{function3.short_description}}}}} | {{#if: {{{function3.short_description|}}}|: {{{function3.short_description}}}}} | ||
}} | }} | ||
Revision as of 15:42, 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 |