About this Example

Simple example for Doxygen.

+---example/     <-- this example
|   |   code.dox <-- example documentation separated from the code
|   |   main.dox <-- example main page or main section
|   |   srs.dox  <-- example Software Requirements Specification
|   |   make.bat <-- batch script to build the documentation
|   |
|   +---inc
|   |       header.h <-- example header file
|   |
|   +---src
|   |       source.c <-- example source file
|   |
|   \---test
|           test1.c  <-- example test file (free function)
|           test2.c  <-- example test file (class Foo)

Note: This example illustrates the way Doxygen allows you to separate the documentation from the source code. Specifically, the sample code provides only minimal documentation. The actual documentation is external (in the file code.dox). Such an approach is advantageous for safety-related code, where changes to the code base are prohibitively expensive, which would otherwise hinder improving the documentation independently.

Remarks: Additionally, the example code and documentation illustrate how to implement classes in C and how to document such classes with Doxygen.

Spexygen-Generated Documentation

Spexygen logo:

Image caption.

The following sections contain the Spexygen-generated documentation of this example:

Software Requirements Specification