The Argument element controls the appearance of the help for a particular argument of a function. It should always appear inside a Function element. The required attribute Name should be set to the name of the argument to which the element applies. The Argument element may contain zero or one Description element, and any number of TextDescription elements. The element has one optional attribute: Syntax.
Required. The Name attribute is required. It defines which argument this element will be applied to.
The Syntax attribute controls the position of the standard argument syntax-based text, such as "X should be a vector of numbers...". The text may be positioned as a continuation of the argument's description (Continuation), as a paragraph following the argument's description (Paragraph), or omitted (None). If omitted, it is assumed to be Continuation.
If the HideValueList attribute is false or omitted, then a table of values and descriptions will be added to the argument's help text if a value list is present. If the attribute is true, then the table will be omitted.
|
Number of occurrences |
Unlimited |
|
Parent elements |
|
|
Child elements |