Part of the Khronos Group
OpenGL.org

The Industry's Foundation for High Performance Graphics

from games to virtual reality, mobile phones to supercomputers

Results 1 to 4 of 4

Thread: Better API Documentation

  1. #1
    Junior Member Newbie
    Join Date
    May 2001
    Location
    Austin, TX
    Posts
    5

    Better API Documentation

    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
    Thanks,
    Gordon Hollenbeck

  2. #2
    Advanced Member Frequent Contributor
    Join Date
    Apr 2000
    Location
    Adelaide, South Australia, Australia
    Posts
    839

    Re: Better API Documentation

    Hello,

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

    What do you think is inadequate?

    cheers,
    John

  3. #3
    Member Regular Contributor
    Join Date
    Mar 2001
    Posts
    340

    Re: Better API Documentation

    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.

  4. #4
    Advanced Member Frequent Contributor
    Join Date
    Apr 2000
    Location
    Adelaide, South Australia, Australia
    Posts
    839

    Re: Better API Documentation

    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

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •