search

doughague / torpy

A command-line arena game.
GNU General Public License v3.0
1 stars 0 forks source link

Add doxygen git #3

Closed dday76 closed 11 years ago

dday76 commented 11 years ago

Not sure how this fits, but you had mentioned it. It would be nice to see the doxygen presentation of the project...

doughague commented 11 years ago

The Doxygen code (API) documentation can be created by downloading doxygen and typing:

make doc

or

doxygen doc/Doxyfile

The generated html documentation should NOT be committed to the github repo! The reason for this is that it tends to be a lot of weird looking html that changes every time there's a change in the code or comments. Once we are relatively stable we can put the doc somewhere like "the-awesome-torpy-game.org". Until then, I strongly encourage you to generate your own local copy of the code documentation as it will significantly facilitate working with the code.