Author Topic: Documentation - automated from code with Doxygen  (Read 1453 times)

0 Members and 1 Guest are viewing this topic.

Offline Echelon9

  • 210
Documentation - automated from code with Doxygen
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]

 

Offline The E

  • He's Ebeneezer Goode
  • Global Moderator
  • 213
  • Nothing personal, just tech support.
    • Steam
    • Twitter
Re: Documentation - automated from code with Doxygen
And as of revision 62, the documentation is online here: http://starshatter-open.googlecode.com/svn/trunk/Doc/doxygen/html/index.html
Let there be light
Let there be moon
Let there be stars and let there be you
Let there be monsters and let there be pain
Let us begin to feel again
--Devin Townsend, Genesis

 

Offline Echelon9

  • 210
Re: Documentation - automated from code with Doxygen
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!