Difference between revisions of "Source code documentation"
From VDrift
m (8 revisions: Import from old wiki (on 15 May 2012)) |
m (Timo 6 moved page Source Code Documentation to Source code documentation: Use lower case for consistency) |
(No difference)
|
Revision as of 13:09, 26 August 2012
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.
Other versions
Doxygen output for the last release will be added soon. When new releases are made, documentation will be made available with the release.
Read Online
You can find Doxygen for VDrift trunk at the following URL: http://vdrift.net/doxygen/trunk/
Download
Downloadable PDF and Zip archives of the HTML version for offline browsing will be available soon.
Help improve documentation
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: