Documentation
LB-- opened this issue · 3 comments
The project needs documentation, which I will work on when I can. I've already got basic doxygen support and everything in src/util/ is already documented.
Any pull request adding or fixing documentation should have the Documentation milestone. The final pull request after which all code is documented should contain the text Fixes #55.
Agreed. This is my plan before I start writing much. I think we need more
high level documentation as well. Not just documentation in the code. Would
be easier for people to look at say "OK I want to work on this module, I
know exactly where to go."
On Nov 16, 2013 8:08 PM, "LB--" notifications@github.com wrote:
THe project needs documentation, which I will work on when I can. I've
already got basic doxygen support and everything in src/util/ is already
documented.—
Reply to this email directly or view it on GitHubhttps://github.com//issues/55
.
Disregard my previous message if it got emailed to you.
@ResidentBiscuit, I agree about the higher level documentation.
I think i'll start writing wiki pages like I did for the graphics module for a whole bunch of other things that I'm familiar with. That should help clear a lot of stuff up when people have questions.