Adding to the documentation

Discuss about anything related to the Irrlicht Engine, or read announcements about any significant features or usage changes.
Post Reply
wyrmmage
Posts: 204
Joined: Sun Mar 16, 2008 3:12 am
Contact:

Adding to the documentation

Post by wyrmmage »

First off, I'd just like to say that Irrlicht's documentation is quite good compared to most graphics engines :) That being said, there are some functions that are missing explanations and just some general things missing. Since I'm still a newbie at using Irrlicht, I don't know what a lot of the functions do or what they return; I've found that there is quite a bit of information missing from the documentation concerning valid parameters and what functions return (like if the return value is in pixels or units, for example). As I go through and learn what some of these functions do, I'd like to update the documentation with relevant information so that others wont have to put quite as much work into finding these things out.

Is this a good idea? Do you guys think the documentation needs this, or would it just make it cluttered? How would I go about doing this? Should I just submit patches to the tracker with updated header files containing the updated descriptions, or is there a better way to go about this?

Thanks :)
-wyrmmage
Worlds at War (Current Project) - http://www.awkward-games.com
Ganadu'r, The Eternal Sage (Other Current Project) - http://rpg.naget.com
MasterGod
Posts: 2061
Joined: Fri May 25, 2007 8:06 pm
Location: Israel
Contact:

Post by MasterGod »

I think its a great idea. Use patches. (Try before 15th cause that's when v1.4.1 is released so it would have your fixes).
Image
Dev State: Abandoned (For now..)
Requirements Analysis Doc: ~87%
UML: ~0.5%
Post Reply