Game-Decompilation/Petari
1
0
Fork 0
mirror of https://github.com/SMGCommunity/Petari.git synced 2024-11-28 07:50:51 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
be62e5ceab
Petari/docs/DOCUMENTATION.md
shibbo e62a2fe79a small fixes
2022-10-08 01:54:04 -04:00

1022 B
Raw Blame History

Documentation

  • Doxygen is the documentation toolset that we use to document Petari's code onto a web page for easy viewing. Doxygen also uses Graphviz for graphics for displaying inheritance.

Installing

  • Follow the instructions that coorespond to your OS on Doxygen's installation page. If you want as well, you can install GraphViz, but this is optional. If you choose to not install GraphViz, set HAVE_DOT in the Doxyfile to NO.

Running

Once everything has been installed, just run doxygen in the root directory and it will generate HTML files in a new folder named doxygen. Verify that the output meets standards before pull requesting documented headers / code! Do not worry about submitting any form of the HTML, the documentation server will pull the repository every 15 minutes and then compile the documents itself here.