[next] [prev] [prev-tail] [tail] [up]

#### 5.3.10 errors : Error section.

The errors tag is used to document any errors that can occur when calling a function or procedure. it is placed in a different section in the generated documentation. It occurs inside a element tag, at the same level as a descr or short tag. It’s contents can be any text or formatting tag.

Example:

<element name="MyDangerousFunction">
<descr>MyDangerousFunction is a dangerous function</descr>
<errors>When MyDangerousFunction fails, all is lost</errors>
</element>

See also: descr (165), short (212), element (173), seealso (210)

[next] [prev] [prev-tail] [front] [up]