Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #55

Open
LB-- opened this issue Nov 17, 2013 · 3 comments
Open

Documentation #55

LB-- opened this issue Nov 17, 2013 · 3 comments
Assignees
Milestone

Comments

@LB--
Copy link
Member

LB-- commented Nov 17, 2013

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.

@ghost ghost assigned LB-- Nov 17, 2013
@jaredready
Copy link
Contributor

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--" [email protected] 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
.

@LB--
Copy link
Member Author

LB-- commented Nov 17, 2013

Disregard my previous message if it got emailed to you.

@Thumperrr
Copy link
Member

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants