Users manual for doctext: Producing documentation from C source code
One of the major problems that software library writers face, particularly in a research environment, is the generation of documentation. Producing good, professional-quality documentation is tedious and time consuming. Often, no documentation is produced. For many users, however, much of the need for documentation may be satisfied by a brief description of the purpose and use of the routines and their arguments. Even for more complete, hand-generated documentation, this information provides a convenient starting point. We describe here a tool that may be used to generate documentation about programs written in the C language. It uses a structured comment convention that preserves the original C source code and does not require any additional files. The markup language is designed to be an almost invisible structured comment in the C source code, retaining readability in the original source. Documentation in a form suitable for the Unix man program (nroff), LaTeX, and the World Wide Web can be produced.
- Research Organization:
- Argonne National Lab., IL (United States)
- Sponsoring Organization:
- USDOE, Washington, DC (United States)
- DOE Contract Number:
- W-31109-ENG-38
- OSTI ID:
- 70803
- Report Number(s):
- ANL/MCS/TM--206; ON: DE95012943
- Country of Publication:
- United States
- Language:
- English
Similar Records
NOSTRADAMUS programmable translator user's manual and programmer's manual
Professional Levels of Computer Program Documentation