Proper documentation

Is there any proper documentation for JOGL?

What I have found so far is OK if you know what you are doing, but way too complex for somebody starting out.

This is not necessarily a criticism, but an open-source project can only survive if the bar of entry for using the software is not set too high.

Installation – You can download the jogl.ar files easily enough, but no direction on what to do to run the first demo, no documentation. All you have is a bunch of .class files and a couple of DLLs.

JOGL User’s Guide - The one page user guide (index.html) is all over the place. Instead of showing a single example and explaing bit and pieces, it mixes design decisions, implementation issues with tips on how to do it. Unless you are already familiar with a lot of the code, reading the user guide is not going to help.

Forums - “Getting Started with JOGL” thread is a bit more useful. It provides examples for a change, but “forums” should be for discussing the software, not for figuring out how to use it. Forums also have additional noise, everything from inside jokes to misunderstandings. The user guide should be concise, relevant information.

Documentation – Where can I find the documentation and public methods for say GLPanel? Surely, the answer cannot be, download the code from CVS, inspect it and make guesses about how things might tie together. I am still hoping there is an answer to this question out there.

[EDIT: jogl_javadoc_public.tar.gz does have the javdoc documentation which is a start]

JOGL is impressive. It does some things well, but the level of effort to learn it and use it seems to be too high. I hope somebody will be able to point me to the “hidden” documentation or maybe push for documentation to be a higher priority item for JOGL’s future.

Cheers,

Yusuf

A suggested table of contents:

  1. Where to download JOGL
  2. How to install JOGL. For Eclipse, JBuilder, NetBeans etc.
  3. How to run the demos
  4. What is the ‘jogl.1thread’ property?
  5. Use of JOGL in AWT and Swing
  6. Why the need to use NIO Direct Buffers in JOGL
  7. How to get a Java2D Image into an OpenGL texture
  8. How to use GLEventListener properly

If we can nail down a nice table of
contents, then I think a wiki page
can be put up so everyone can contribute
in bits and pieces, which won’t take
too much time.

Something like javaalmanac.com would
be very nice too.

.rex

FORGET THAT!

I want to see OpenGL documentation as part of the JOGL JavaDoc API.

Nothing more frustrating then watching the popups in NetBeans say “GL.glSomeMethod( int, int, int )” and you have no idea what the three parameters are.

I was going to write a Java program which would strip the OpenGL documentation from opengl.org, and insert it into the JOGL as JavaDocs for each method.

Would anyone care if I did this?

That would be interesting but I think you’ll run into some problems. The OpenGL documentation is massive and having it as Javadoc in one file will probably not scale well. One possibility would be to translate the documentation into HTML-friendly format and have links generated in the GL class’s Javadoc up to a known parallel directory containing the real documentation. You would need to modify GlueGen to implement this or any other solution, including being able to specify raw Javadoc for the autogenerated methods.

That would be great, but maybe just use the generic description of each method, not the whole html file… I allready find method look-up quite long in GL.java…