-
Notifications
You must be signed in to change notification settings - Fork 3
Documentation #13
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
Comments
We should use Qt style Doxygen comments if we're using Qt for other things, mainly for consistency. |
I completely was prepared to love doxygen until a few seconds ago but... |
David you should make your own commenting style and extraction program. |
All of the Utility classes are documented. You should check the documentation and make sure its done correctly and conforms to any high standards you may have. |
The only classes left to document in System are:
And everything in Graphics needs documenting (although that can probably wait until you swap it across to using Qt). |
I've started a how to use page on a wiki. It would be nice if someone could fill this in as I want to create a game using it and have no idea how to proceed. I've filled in the steps I've guessed on the wiki. |
I've rewritten your start-up page. I'm going to spend the next few hours making a game for the fortnightly, so if I can I'll add stuff to the wiki as I go. |
Write documentation for everything, or at least the user-facing parts.
The text was updated successfully, but these errors were encountered: