search

Echelon9 / cxbx-shogun

shogun's mirrored branch of the Cxbx original Xbox emulator
GNU General Public License v2.0
33 stars 7 forks source link

Add Doxygen documentation #1

Closed Echelon9 closed 10 years ago

Echelon9 commented 10 years ago

Feature enhancement to add the necessary Doxygen configuration file to locally create documentation directly from the source code.

e.g. https://github.com/openframeworks/openFrameworks/wiki/openFrameworks-doxygen-documentation-style-guidelines

Echelon9 commented 10 years ago

Commit https://github.com/Echelon9/cxbx-shogun/commit/eb9dff4c1560778bd6b207fa0195233a6c091ee6 adds a Doxygen configuration file. This at minimum permits the automatic creation of HTML-based documentation from the source code itself.

More rich documentation of specific functions and files will need to be added separately.

Echelon9 commented 10 years ago

Resolved in PR #10