Wednesday, February 27, 2002

The Cxref Homepage The Cxref Homepage
C Cross Referencing & Documenting tool
Cxref is a program that will produce documentation (in LaTeX, HTML, RTF or SGML) including cross-references from C program source code.
It has been designed to work with ANSI C, incorporating K&R, and most popular GNU extensions.
(The cxref program only works for C not C , I have no plans to produce a C version.)
The documentation for the program is produced from comments in the code that are appropriately formatted. The cross referencing comes from the code itself and requires no extra work.
The documentation is produced for each of the following:
A comment that applies to the whole file.
A comment for the function, including a description of each of the arguments and the return value.
A comment for each of a group of variables and/or individual variables.
A comment for each included file.
A comment for each pre-processor symbol definition, and for macro arguments.
Type definitions
A comment for each defined type and for each element of a structure or union type.


Post a Comment

<< Home