Code Documentation

From ETRacer

Doxygen documentation is at http://www.extremetuxracer.com/doc/html/ The sections below are for describing a "big picture" view of each of the main parts of the code.

Contents 1 Using Doxygen 2 Autoconf/Automake files 3 Main code 3.1 Physical Simulation 3.2 Character Models 4 Widget Library 5 Differences from TuxRacer

[edit] Using Doxygen

To make the most of Doxygen, the code must be documented in a way that Doxygen understands. Learn how to do that here.

To generate Doxygen documentation yourself, install Doxygen and optionally graphviz. Then run the command:

 doxygen path/to/config/file

The ETR Doxygen configuration file is doc/Doxyfile.

[edit] Autoconf/Automake files

[edit] Main code

[edit] Physical Simulation

[edit] Character Models

[edit] Widget Library

[edit] Differences from TuxRacer