Documentation mostly working as desired. Good enough for now. Added some topics.

This commit is contained in:
William Miceli
2021-01-29 19:14:41 -05:00
parent d9b4e5cfe2
commit f8edae68d9
77 changed files with 2135 additions and 176 deletions

View File

@@ -0,0 +1,34 @@
@page documentationGuide Documentation Guide
# Doxygen
The program called "doxygen" ([GitHub Page](https://github.com/doxygen/doxygen) and [Website](https://www.doxygen.nl/)) is what we're using to document our project and try to make things a bit simpler/easier not only for us, but also future projects or people looking at what we've done.
It simply uses a small configuration file at the root of the project `/Doxyfile` to store some settings, and the rest is through mainly Markdown files (`.md` or `.markdown`) and source code files.
It is setup (as of writing this) that someone can simply open the `/Doxyfile` in the GUI Wizard, click on the "Run" tab, then "Run doxygen", and everything will be updated... that's it.
# Updating Documentation
You need to have installed the program from either the GitHub page or website, then simply open the `/Doxyfile` within the GUI frontend or "Wizard".
# Important Notes
- Make sure that the `/Doxyfile` stays where it's at! It should be kept at the root directory (just to keep things simple)
- Make sure you use RELATIVE paths when changing configurations, or else when someone else tries running the `/Doxyfile`, they'll have to re-do all of them in order for it to start functioning again.
## For Consistency
- Please make sure the internal names of files are using "camelCase"
- Example: for "@page documentationGuide Documentation Guide"
"documentationGuide" is the name used internally by doxygen.
"Documentation Guide" is what shows up on the output documentation.