Cxref

Cxref is an open source and totally free command-line software implemented in C and designed to allow developers to easily and quickly generate documentation, as well as cross-references, from the source code of a program that was also written in the C programming language.

Features at a glance

It can generate the documentation in several popular formats, including (but not limited to) HTML, LaTeX, SGML, and RTF. In addition, the program works well with ANSI C, but it doesn’t work with C++.

The application alsol generates documentation of files, functions, variables, #include, #define, and type definitions. Detailed information and usage examples can be found on the official homepage or the project (see link below).

Command-line options

The software offers a wide variety of command-line options, which can be viewed at a glance by running the ‘cxref --help’ command in a terminal emulator. Among the most useful ones, we can mention the ability to delete all references to the name files, specify the output folder for the documentation, the base filename for the output documentation, as well as the root dir of the source tree.

Among other command-line options of the program, we can mention support for using all comments, support for inserting comments verbatim in the output, support for using block style for comments, support for ignoring all comments, support for cross referencing, support for producing warnings, LaTeX, raw, SGML, HTML and RTF output.

Getting started with Cxref

It is extremely easy to install the Cxref software on your GNU/Linux computer. Just download the latest archive from Softoware, save it somewhere on your computer (e.g. Home folder), unpack it with your favorite archive manager, open a terminal emulator, navigate to the location of the extracted archive files using the ‘cd’ command, run the ‘./configure && make’ command to optimize/configure and compile the program, and execute the ‘make install’ command as root or with sudo to install it system wide.

What is new in this release:

• Updated for latest version of autoconf.
• Allow structure initialisers to have multiple components (e.g. a.b=1).
• Remove gcc warning messages.
• Change Makefile for better comptibility with FreeBSD.