Doxygen documentation is available for VDrift. Currently only the Subversion trunk is available. It is generated daily from the latest version of the Development version.
Doxygen output for the last release will be added soon. When new releases are made, documentation will be made available with the release.
- Install doxygen
- Set the
VDRIFT_ROOTenvironment variable to the directory of your project. Do not use a trailing slash.# on Linux export VDRIFT_ROOT=/home/yourname/vdrift
- Run
doxygen -sto generate docs.
You can find Doxygen for VDrift trunk at the following URL: http://vdrift.net/doxygen/trunk/
Downloadable PDF and Zip archives of the HTML version for offline browsing will be available soon.
If you are writing new code for VDrift, it would help to write comments using a format Doxygen can take advantage of. Here are a few handy links describing how to do that:
Category:Development