Difference between revisions of "Source code documentation"

From VDrift
Jump to: navigation, search
m (added to external resources category)
m (Spelling: folling --> following)
Line 5: Line 5:
  
 
== Read Online ==
 
== Read Online ==
You can find [http://vdrift.net/doxygen/trunk/ Doxygen for VDrift trunk] at the folling URL:
+
You can find [http://vdrift.net/doxygen/trunk/ Doxygen for VDrift trunk] at the following URL:
 
http://vdrift.net/doxygen/trunk/
 
http://vdrift.net/doxygen/trunk/
  

Revision as of 13:21, 28 December 2010

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: