Doxygen Comments in Code

[GoogleCodeExporter]

What new or enhanced feature are you proposing?
Use more and better comments throughout the code to allow new coders to more 
quickly understand what it is doing and allow them to start contributing.
This could be done with doxygen or just regular comments. The only problem with 
doxygen is that it would require an extra dependency and a new build target in 
the makefile to build the documentation.

What goal would this enhancement help you achieve?
It would allow for easier upkeep of the code as we could easily see what 
everything does.

Original issue reported on code.google.com by d.ruler...@gmail.com on 2 Apr 2013 at 7:35

[GoogleCodeExporter]

I've started this for comments that are already in the code to move them over, 
but someone who is more familiar with the code needs to document the globals, 
defines, functions and classes. 

Original comment by d.ruler...@gmail.com on 3 Apr 2013 at 5:07

[GoogleCodeExporter]

The Cube engine is pretty bad because of the lack of comments, so there isn't 
much point to add more comments.

Original comment by theonlypwner on 3 Apr 2013 at 11:12

• Changed state: Acknowledged
• Added labels: Priority-Low
• Removed labels: Priority-Unset

[GoogleCodeExporter]

If we started working on that though it could make life a lot easier. 
This is nowhere near a top priority though I'd say.

Original comment by d.ruler...@gmail.com on 4 Apr 2013 at 2:03

[GoogleCodeExporter]

Developing on this engine isn't going to be much easier by placing more 
comments.

Original comment by theonlypwner on 4 Apr 2013 at 11:06

• Added labels: Priority-Trivial
• Removed labels: Priority-Low