Template:Function2
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 overloaded function 1 (and so on for functions 2 through 3)
| Content | optional |
Function 1, return type | function1.return_type | Return type of the overloaded function 1.
| Line | required |
Function 1, parameter 1 | function1.param1 | Name of the parameter 1 of the overloaded function 1 (and so on for parameters 2 through 5).
| Line | optional |
Function 1, parameter 1 description | function1.param1.description | Description of parameter 1 of the overloaded function 1.
| Content | optional |
Function 1, parameter 1 is optional? | function1.param1.optional | "yes" = optional. Any non-empty string will do, but please use "yes" to make standardization easier.
| Line | optional |
Function 1, parameter 1 default value | function1.param1.default | If this is specified, function1.param1.optional must be "yes"
| Line | optional |