Listing error messages when documenting APIs

Subject: Listing error messages when documenting APIs
From: France Baril <France -dot- Baril -at- ixiasoft -dot- com>
To: "TECHWR-L (E-mail)" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 11 Aug 2003 15:04:34 -0400


I'm curious as to what the most common practice is when time comes to list error messages that can be returned by a method.

Do you guys list error messages for each method, even if they are repetitive, or do you have a section with all possible messages and ways to solve problems?

Thanks for your input.

France Baril
Rédactrice Technique / Technical Writer
IXIASOFT
(514) 279-4942
france -dot- baril -at- ixiasoft -dot- com




Follow-Ups:

Previous by Author: RE: Deleting a row in a FrameMaker table - Thanks
Next by Author: Compiled CHM file contains older versions of documents
Previous by Thread: Re: Deleting a row in a FrameMaker table - Thanks
Next by Thread: Re: Listing error messages when documenting APIs


What this post helpful? Share it with friends and colleagues:


Sponsored Ads