[File/Function] Explanations

[Seltraeh]

I plan on going through all of the current server files and making comments in the header of each explaining what the functionality of the file does (and possibly why it's required if necessary) as I build a mental map of how our current server interacts with the client, drogon, cryptopp, and sqlite for any aspiring developers interested in helping but have no clue what is going on.

This is something I'm doing to familiarize myself with the more fundamental functionality and widen my scope for this project and not be so tied down to mission and unit functionality alone.

(That way @arves100 doesn't have to be the only person that can answer questions that go into the inner foundations of the code lol)

[Seltraeh]

Something akin to this:

[Seltraeh]

These comments give the user an idea of how the code is going to accomplish its goal without having to understand what each individual line of code does.

[Seltraeh]

Looking into Doxygen as a solution to this but may still need to create the header comments at the beginning of each file explaining it's overall purpose.

I'm not sure what the procedure will be if one file seems to be doing more than one thing. I may have to break it down into smaller components, but that will become separate issues that can branch off of this topic. (Those cases wont be covered in this issue)

[arves100]

Doxygen sounds like a good idea! it also integrates well with cmake and it supports potentially custom pages and so on.

A cool thing for the future would be hosting it on another page of decompfrontier.github.io specifically in the architecture part.

I've already done some doxygen commit in the code already, for example

server/gimuserver/gme/GmeController.hpp

Line 13 in ade56b4

class GmeController : public drogon::HttpController<GmeController>

.

My preferred way of using doxygen is with the javadoc option enabled (so I can use @command rather than /command) so I would like to have it enabled as well.