Documenting Software using Objections
Certain information should appear in the documentation of a library which uses
Objections.
First, it should be stated that the library is using Objections to
handle error conditions,
and the Objection declarations should appear in the SYNOPSIS
Section.
Second, the description of each function which may raise an Objection
should state which Objection it may raise and under what conditions.
Third, the
default and recovery actions for each Objection should be well specified.
Next topic:
Objections for the Software Client
Previous topic:
Instantiating Objections with a Default Action
© 2004 The SCO Group, Inc. All rights reserved.
UnixWare 7 Release 7.1.4 - 27 April 2004