Message-Id: <200209081642.g88GgP129229@delorie.com>
X-Authentication-Warning: acaxp6.physik.rwth-aachen.de: broeker owned process doing -bs
Date: Sun, 8 Sep 2002 18:25:05 +0200 (MET DST)
From: Hans-Bernhard Broeker <broeker AT physik DOT rwth-aachen DOT de>
To: djgpp-announce AT delorie DOT com
Subject: ANNOUNCE: cxref-1.5d ported to DJGPP
Content-Type: TEXT/PLAIN; charset=US-ASCII
Reply-To: djgpp AT delorie DOT com

The following two uploads are available at your preferred DJGPP /
SimTel.Net mirror, in the v2apps directory:

v2apps/cxr15db.zip --- binary package of cxref-1.5d
v2apps/cxr15ds.zip --- source package

This is a first DJGPP port of cxref, the C cross reference and
documentation genartor program, version 1.5d.

Cxref is a program that inspects lots of C source and header files in one
go and produces formatted output that describes the structure of the
program built from all those files. For every function found, it'll list
all calls to other functions, the functions calling it, the variables
used, and where all of those are, by cross-referencing and sourcefile name
and line number information.  It'll also make similar lists for all
variables and datatypes found.

At the same time, cxref will extract specially formatted comments from the
source files and copy them over into its output.  Somewhat like javadoc,
but for C programs.

The output can got to various formats, the two most popular of which
would be LaTeX and HTML.

One rather useful side-effect is that cxref's engine will uncover some
potential problems in your program that even "gcc -O2 -Wall -W -ansi
-pedantic" can't find, like:

*) Header files that don't work unless you #include some other one before
   them.
*) Conflicts between source file compiled without common headers to
   reveal them.
*) Superfluous definitions or declarations of variables
*) Variables or functions that should be "static", but aren't.

If you ever felt a need to document your program's structure on paper, or
as a nicely hyperlinked document, cxref may be what you've been looking
for.


-- 
Hans-Bernhard Broeker (broeker AT physik DOT rwth-aachen DOT de)
Even if all the snow were burnt, ashes would remain.