Documentation Generation

In house documentation is a pain! And yet when there are multiple programmers, new team members, legacy code or a need for team effort, communication and overall comprehension are important. CC-RIDER tries to make this process as easy and painless as possible by providing Automatic Documentation Generation in the Deluxe Edition.

Documentation for a software code base goes a long way toward enhancing understanding and communication among programmers and management. CC-RIDER lets you do all your documentation in one place: the source code, where it can be done most accurately and conveniently by the programmer.

CC-RIDER generates documentation for your application automatically by analyzing your code and associating source code comments with declarations and definitions of functions, classes, variables, macros, and other symbols.

All tree charts can be filtered, previewed, and then output using any Windows printer driver installed on your system. They can also be exported as Windows Metafiles in three different formats: 16-bit metafiles (.WMF), Aldus Placeable Metafiles (.WMF) and 32-bit Enhanced Metafiles (.EMF).

CC-RIDER can also automatically generate function prototype headers for your entire program or a specific source module. A detailed textual symbol report (or "Log" file) can be written as well.

We require no special formatting and generate documentation automatically from source code comments. This allows all documentation to be done in one place, simplifying the task and making it more reliable.

Documentation
Here is an example of a portion of one page from a typical generated document:

HTML Generation
Here is an example of a HTML portion of one page from a typical generated document:

Wall Size Charts
Here is an example of a wall size chart portion of one page from a typical generated document:

"I'm a happy user of CC-Rider and will in the foreseable future use it a lot more than before"

Erlend Hammer, Norway

Configure and Filter Documentation
With a variety of formatting and output options, CC-RIDER is a simple, flexible solution for your documentation requirements. From wall size charts of the source code to Intranet exchanges, our extensive documentation is efficient and beneficial for a single programmer or a whole team.

The output can be extensively customized through a number of dialog box options specifying which symbols to document, as well as how to organize the output, for example, alphabetical, or grouped by symbol type (functions, macros, classes, etc.)

Output can also be filtered in three ways: by symbol name, by source file where a symbol was declared, or by specific text in the associated comment. This last option lets you customize documentation by simply defining a special character sequence in source code comments for symbols you would like to document (or not document).

The formatting of the output documentation is determined by a set of document templates. These special RTF and HTML files can be modified by the user to specify text and fonts, etc. to be used in generating the automatic documentation:

.

File, Name and Comment filters can be applied to focus generated documentation on a specific subset of your project. You can, for example, easily filter out the compiler’s header files from your documentation.

Documentation is controlled by a flexible Documentation Generation Options Dialog, as well as a set of Documentation Template Files which determine formatting, fonts, etc.: