search

VEGO-Engine / Engine

2 stars 0 forks source link

Added doxygen configuration #43

Closed Nanogamer7 closed 4 months ago

Nanogamer7 commented 5 months ago

This PR adds a configured Doxyfile, including a workflow to automatically deploy via GitHub pages, and styling for the generated documentation. However due to the extend of undocumented code in the code base, this PR doesn't add complete documentation, which should be done after restructuring the code as described in #29. Some parts are documented as a sample on how future documentation could or should look like.

Nanogamer7 commented 5 months ago

Documentation doesn't differentiate between internal documentation (i.e. documentation only relevant for further engine development) and external documentation (i.e. documentation of functionality included in the API, potentially also relevant for game developers)