Laserfiche WebLink
Comments associated with a revision should be entered only with the revision (see Task <br />Memorandum 1.05-20) and should not be included within the body of code. For example, do not <br />include comments like the following in the body of the code: <br />/* <br />** Lines to swap values were removed by SAM, 30 Jun 1994. <br />*/ <br />External Documentation <br />External documentation for routines will consist of simple UNIX man pages. The man pages will <br />have a minimum of the following sections: <br />NAME - name of routine and one-line description <br />? <br />SYNOPSIS - routine arguments <br />? <br />DESCRIPTION - description of routine capabilities <br />? <br />DIAGNOSTICS - return code of routine <br />? <br />SEE ALSO - list referenced routines <br />? <br />AUTHOR - author of the routine (the source code, not the man page) <br />? <br />Additional sections will be added to man pages where necessary (e.g., LIMITATIONS, AUTHOR's <br />NOTE). The SYNOPSIS section will indicate the include files necessary to declare the routine and <br />the library to be specified when linking the routine. The DESCRIPTION section will contain a table <br />with contents as follows: <br />Input/ <br />Variable Output Type Description <br />stationI/OStationStation that is to be retrieved. <br />Man pages for routines will be under revision control (see Task Memorandum 1.05-20) in a <br />subdirectory under the library source code and will be installed to the standard system man page <br />man <br />location (e.g., ). Man pages will be viewable using the UNIX command and <br />/usr/man/manl <br />pman <br />will be printable using the utility developed by RTi (this utility has been tested on the SGI <br />mosaic <br />workstations). Additionally, a interface to UNIX man pages will be developed (see Task <br />Memorandum 1.05-12). <br />3.0 CONCLUSIONS AND RECOMMENDATIONS <br />The documentation guidelines covered in the discussion section are designed to facilitate the <br />development of useful, standardized documentation for routines used in CRDSS. The following <br />recommendations are made: <br />3 <br />A275 05.10.94 1.05-11 Malers <br />