On Wednesday 23 August 2006 10:46, Antonio Bleile wrote: > Take QT. It's the best documented API I've ever seen. > I admit that they put a lot of effort into it, and I'm well aware > that OpenSG can't get to those levels. But it's a good reference...
I can second that. I've never seen a better documentation. > QT uses good member names too, and they even do document the most > intuitive of them anyway, like: > > " > bool QImage::isNull () const > Returns true if it is a null image, otherwise returns false. > A null image has all parameters set to zero and no allocated data. > " > > or in the same class: > > " > int QImage::height () const > Returns the height of the image. > " IMHO this is one of the example where the description is not necessary. I mean the height of an image object is somehow self-explanatory. What I would be more interested in is something like the module/key-technology documentation of Qt4. If for example i want to use the Qt4 model/view framework and i have never used it before, i simply go to the "Model/View Programming" page available on the documentations main page under section "Key technologies" and after reading that i know about: - the model/view concept (even if i never header of that before) - the classes involved - the relations between the involved classes - several (documented) examples The page is here: http://doc.trolltech.com/4.1/model-view-programming.html BTW: It's called Qt - QT stands for Quicktime (reminds me of some other name similarities ;) Peter -- | "Without music, life would _O_/ \_O_/ | Fraunhofer IGD, Darmstadt | | be a mistake - I would / )) [] | Peter Eschler | | only believe in a god who \\ // | Tel.: ++49-6151-155-279 | | knew how to dance." (Nietzsche) // \\ | Email: [EMAIL PROTECTED] | ------------------------------------------------------------------------- Using Tomcat but need to do more? Need to support web services, security? Get stuff done quickly with pre-integrated technology to make your job easier Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642 _______________________________________________ Opensg-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/opensg-users
