CodeInfo

The CodeInfo toolset is composed by several programs and configuration files. Here is the diagram of the complete system:

The CodeInfo Generator extracts source code elements from C/C++ files. The extraction options are defined in the CodeInfo Generator Project. The application supports listing files from Microsoft Visual Studio workspaces, plain text file path lists or by specification of the directory where files are stored. The extraction process has many options, you can choose what kind of elements to extract, and what level of access to reach. The result is a CodeInfo file that contains just the names and types of elements but no descriptions. If the CodeInfo file already exists, the CodeInfo Generator inserts the new items in the file and maintains the existing items.

The CodeInfo Editor is the tool for editing the CodeInfo file. Each type of source code element has its own view. Here you can insert short and long descriptions, notes, remarks and so on, for each element you consider important. You can also decide if an element needs to be included in the final documentation or not.

The documentation formatters transform the XML documentation file in the format you choose. Each format has a set of options that are saved in its own settings file. The formatters can generate inheritance charts as images.