Hard Light Productions Forums

Hosted Projects - Non-FreeSpace => StarShatter Open Source Project => Topic started by: Echelon9 on May 31, 2012, 08:22:07 am

Title: Documentation - automated from code with Doxygen
Post by: Echelon9 on May 31, 2012, 08:22:07 am

As of revision 59 we've now got infrastructure to locally automate documentation of the Starshatter codebase.

Being based upon FS2_Open's Doxygen system, the instructions here work: http://www.hard-light.net/wiki/index.php/Doxygen_Documentation

For now it will simply produce nicely formatted HTML and Latex layouts of the current code. We can progressively add in complete documentation of classes, methods and data as we go.

[attachment deleted by ninja]

Title: Re: Documentation - automated from code with Doxygen
Post by: The E on May 31, 2012, 01:00:21 pm

And as of revision 62, the documentation is online here: http://starshatter-open.googlecode.com/svn/trunk/Doc/doxygen/html/index.html

Title: Re: Documentation - automated from code with Doxygen
Post by: Echelon9 on June 03, 2012, 10:01:25 am

Quote from: The E on May 31, 2012, 01:00:21 pm

And as of revision 62, the documentation is online here: http://starshatter-open.googlecode.com/svn/trunk/Doc/doxygen/html/index.html

Fantastic, a good resource to have!