3.15 Errors

The Errors header is used to document errors that can happen during the execution of a procedure or a function.

     Example: Errors example  
      1  Function: Min -- Return smallest of two values.
      2
      3    Min returns the minimum of A and B.
      4
      5    Parameters:
      6      - A -- first value
      7      - B -- second value
      8
      9    See Also: <<Max>>
     10
     11    Errors:
     12
     13      When ``Min`` fails, dangerous things can
     14      happen.

A Errors header can only appear once per element after all Sub Elements, Result, See Also, Note and Notes headers.