INTRODUCTION
Overview
Download and Install
Documentation
Publications

REPOSITORY
Libraries

DEVELOPER
Dev Guide
Dashboard

PEOPLE
Contributors
Users

SourceForge.net Logo
Project
Download
Mailing lists

 

         

Documentation

Note:
Reviewed for release 0.0.1.
GearBox documentation is written in Doxygen format (*.dox files). It's possible to convert Doxygen files into a variety of formats, but we normally stick with HTML. You have 3 options on how to access it.

View On-line

Download Archive

Build Locally
To generate documentation, go to the doc directory on the top level of the GearBox distribution and run doxygen. (This works for both GearBox releases and the SVN version.)

$ cd [GEARBOX-SRC]/doc
$ doxygen doxyfile

The documentation is created in a new directory called html. Use your browser to open [GEARBOX-SRC]/doc/html/index.html

 

Generated for GearBox by  doxygen 1.4.5