Skip to content

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

Open
qualiaa opened this issue Jun 9, 2013 · 7 comments
Open

Documentation #13

qualiaa opened this issue Jun 9, 2013 · 7 comments
Milestone

Comments

@qualiaa
Copy link
Member

qualiaa commented Jun 9, 2013

Write documentation for everything, or at least the user-facing parts.

@ghost ghost assigned qualiaa Jun 9, 2013
@DavidTruby
Copy link

We should use Qt style Doxygen comments if we're using Qt for other things, mainly for consistency.

@DavidTruby
Copy link

I completely was prepared to love doxygen until a few seconds ago but...
IT BINDS POINTERS TO NAMES, NOT TYPES!!!
This makes me sad.

@Anstow
Copy link
Contributor

Anstow commented Jun 11, 2013

David you should make your own commenting style and extraction program.

@Anstow
Copy link
Contributor

Anstow commented Jun 13, 2013

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.

@Anstow
Copy link
Contributor

Anstow commented Jun 16, 2013

The only classes left to document in System are:

  • IWindow
  • ServiceLocator
  • Window

And everything in Graphics needs documenting (although that can probably wait until you swap it across to using Qt).

@Anstow
Copy link
Contributor

Anstow commented Feb 9, 2014

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.

@qualiaa
Copy link
Member Author

qualiaa commented Feb 13, 2014

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.

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