search

tank-dev / tank

A 2D C++ game engine taking inspiration from FlashPunk
Boost Software License 1.0
12 stars 3 forks source link

Documentation #13

Open qualiaa opened 11 years ago

qualiaa commented 11 years ago

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

DavidTruby commented 11 years ago

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

DavidTruby commented 11 years ago

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 commented 11 years ago

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

Anstow commented 11 years ago

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 commented 11 years ago

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

Anstow commented 10 years ago

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 commented 10 years ago

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.