tool: CDG - C Documentation Generator


Language:
ANSI C, K&R C
Version:
1.3
Parts:
documentation, document generator (all in one file)
Author:
Peter Knoppers <P.Knoppers@ct.tudelft.nl>
Location:
http://cardit.et.tudelft.nl/~knop/cdg13.tar.gz (Anonymous ftp not supported; use your WWW-browser and save it in a file.)
Description:
Cdg reads a set of C-source files and generates a two-column listing of those sources where all lines are numbered. After the listing part comes a three-column cross-reference table which gives for each identifier a list of line-numbers where this identifier occurs in the source listing part.

This format resembles the format that John Lions used in "Source Code and Commentary on UNIX level 6".

Conformance:
Should operate on all K&R and ANSI C programs. There are some restrictions on the placement of matching #ifdef, #else and #endif directives, or else the way an identifier is used may be incorrectly determined.
Features:
+
Non-C sources can be included in the output
-
Non-C sources will not be cross-referenced
+
Long lines are folded in the output and marked as such
+
Customizable footer for copyright or other messages
+
Cross reference list distinguishes definition versus use of an identifier
+
Possibility to exclude certain identifiers
+
Can save a list of all identifiers with linenumbers
+
Identifiers can be included or excluded from the cross- reference listing depending on their use
+
PostScript output can be generated for A4 or US Letter size paper, on the non-PostScript printers only A4 is supported.
Bugs:
None known (except the restriction mentioned under "conformance").
Restriction:
GNU conditions
Requires:
Unix, ANSI-C compiler (preferably gcc) (to build it), sort(1), PostScript printer, or HP DeskJet 500 or LaserJet printer, or GhostScript plus almost any popular printer.
Ports:
Linux
Portability:
Little experience at this time, should be quite portable.
Status:
Works fine for the author...
Discussion:
Email the author.
Help:
Email the author.
Support:
Email the author.
Announcements:
http://cardit.et.tudelft.nl/~knop/index.html#cdg
Updated:
May 4 1999

Related Items

language: ANSI C

category: compiler generators and related tools summary, or expanded.

category: text manipulation summary, or expanded.


This work supported by Idiom Consulting. Idiom is a full-service ISP, providing Internet access in Northern California and Web hosting worldwide.

Please send updates to free-compilers@idiom.com

The HTML is maintained by David Muir Sharnoff and the entries themselves are currently maintained by Bryan Miller.

Copyright (c) 1992-1998 David Muir Sharnoff, All Rights Reserved
Copyright (c) 1994-1996, Steven Allen Robenalt, All Rights Reserved