This is basically how I learned the HAM development kit over at ngine.de for Gameboy Advance development. I browsed the Docs.
However, I've been having a bit of a difficult time doing the same thing with the Irrlicht docus, and I couldn't figure out why. Untill last night, when I tried to set up a GUI.
No example code.
See, HAM was relatively simple. It doesn't use a class hierarchy, no interfaces, no templates. In fact, it was originally designed to be a set of macros to help low level development on the console.
However, Irrlicht is a little more difficult. If you are wise in the ways of C++, I guess it's not too bad... however, I stayed strictly C for the longest time, and now I'm taking a crash course on C++. And I keep shooting my own foot.
So, what I'm really saying is that the API Docu could be made much more readable as a reference if example code were included. For example, in the API Documentation for the IGUIWindow class, after the "Constructor & Destructor Documentation" section, you would add a "Example Code" section, that looks like this:
(forgive me if this is bad code, I slapped it togeather from the GUI tutorial)//Create Irrlicht Device
IrrlichtDevice *device = createDevice(EDT_SOFTWARE, dimension2d<s32>(640, 480));
// Set up the GUI Environment
IGUIEnvironment* env = device->getGUIEnvironment();
// Set up the window
IGUIWindow* window = env->addWindow(rect<s32>(100, 100, 300, 200), true, L"WindowCaption");
This isn't a complete tutorial that shows how to make a MDI application. All it is is a code fragment that shows the steps required to make a window. First you need the "device," then you need the "env"ironment, then you "addWindow" to the environment. C++ beginners (Me, specifically!) then don't try something like
Code: Select all
IGUIWindow window = IGUIWindow->IGUIWindow(rect<s32>(100, 100, 300, 200), true, L"This no work");I don't know how hard (or easy) this might be. I know that the docus are made with Deoxygen, and come from the header files themselves. And Neko problebly doesn't need another gripe to be thrown upon him.
I'd like to patch togeather my own examples as I painfully learn them into my own. I'm looking up some CHM editors so I can add the snippets as I get to them. I guess I was just pointing out that if it wasn't too difficult to add, it'd be a great addition![/code][/quote]
