PDA

View Full Version : Better API Documentation



gordon1986
05-14-2001, 01:31 PM
I believe that the OpenGL API is poorly documented; Developing products using OpenGL could be greatly improved if the API was documented... I suggest that you use Sun's Java Documentation format... There are a large number of developers who know Java, and it has a documentation standard...
http://java.sun.com/j2se/1.3/docs/api/index.html

john
05-14-2001, 03:06 PM
Hello,

the man[ual] pages aren't enough???
OpenGL is *amazingly* well documented, IMHO.

What do you think is inadequate?

cheers,
John

ET3D
05-15-2001, 06:02 AM
I think that the problem is that the spec is hard to read, while the OpenGL reference book would have been nice to have as nicely formatted HTML pages. A downloadable organized HTML collection like the Java docs could be nice.

john
05-15-2001, 04:07 PM
Hello,

- oh.

investigate wget. its a program to mirror/dlownload webpages. it works wonders. =)

(incidentially, if you have a unix system then you get all the man pages for opengl. I can type man glBegin on the command line and get the same HTML spec...)

cheers,
John