Defines an argument to a macro.
The text of this tag should document the purpose of the argument.
<macro docname="average"><signature><argument name="numbers" required="yes" check="len:numbers gt 0">A list (or other sequence) of numbers</argument></signature><return value="sum:numbers / len:numbers" /></macro>
name | purpose | type | required? | default | choices |
---|---|---|---|---|---|
check |
A boolean expression that the attribute must satisfy | function | No | ||
default |
A value to use if the argument is not supplied | function | No | ||
name |
Name of the attribute | text | Yes | ||
required |
Is this argument required? | boolean | No | yes |