#109 Restyle Comments fix

[bobbybrot]

Fixed numerous warnings encountered when using Doxygen to document code. Added new comments for easier code readability of some functions.

Note: There are still a few warnings that needs to be corrected by someone more familiar with the project's code. I have attached a file with the last warnings that needs correcting and where they can be found.

I hope you find my edits acceptable. Documentation.leftover.txt

[Fohlen]

Hello there @bobbybrot and thank you for your contribution, it's very much appreciated! We will look over this in the next couple days, suggest likewise improvements and fix the mentioned left over warnings.

[bobbybrot]

Sure thing, I shall keep an eye out. :)

[bobbybrot]

As a question, what will happen with the leftover functions that need documenting?

[Croydon]

I would suggest to fill a follow up issue and merge this pull request now. Since it will go first intos @a-teammate's branch he needs to decide.

[bobbybrot]

Alright thanks for letting me know. I will wait it out and see what happens.

[bobbybrot]

(Sorry wrong button :D)

[a-teammate]

contents of documentation.leftover.txt:

yo

• inexor/texture/slot.hpp line:190, 'root' is not documented

• inexor/texture/slot.hpp line:158, 'forceload' is not documented

• inexor/server/gamemode/gamemode_server.hpp line:60, 'type' and 'p' is not documented

• inexor/engine/worldio.cpp line:924, 'changed' is not documented

• inexor/engine/worldio.cpp line:454, 'f' 'co' 'size' and 'failed' are not documented

• inexor/engine/worldio.cpp line:468, all parameters are missing documentation information

• inexor/engine/world.cpp lines:552-555, all functions are missing parameter documentation

• inexor/util/Subsystem.hpp line:125, Not sure how to deal with not declared or defined warning for 'void tick()' function

void tick() gets executed every frame (we have a main loop). this function is actually virtual meaning any class deriving from this class, will actually want to implement this function (which then gets executed every frame)

• inexor/util/textedit.hpp line:767, same as issue above

• inexor/engine/sound.cpp line:601, include file 'unistd.h' not found, perhaps you forgot to add its directory to INCLUDE_PATH?

unistd.h is for unix only. try https://stackoverflow.com/a/22445280

• inexor-core/readme.md line:3, "Unexpected HTML tag <img> found within <a href=...> context" Can this warning be ignored and if not, how do you fix this? yeah just ignore it or maybe google got a solution

dunno about the rest atm :D try to add the documentation or if not possible reformat the info in the doc comment to silence the warning :)

[bobbybrot]

There we go, that should bring us closer to closing issue #109

[a-teammate]

Very nice! Thank you, I will put this into server_standalone as soon as I can resume working on it (currently in holidays)

This will make it into 0.9 definitely :)

[a-teammate]

merged with remove_standalone2 in 3760f2dc25efe0e88aa79ab36539e7c61a155649 ! :) As i can finally resume working on remove_standalone2, it will come into master soon