Bug 321 - GL doc could be improved
Summary: GL doc could be improved
Alias: None
Product: Jogl
Classification: JogAmp
Component: core (show other bugs)
Version: 1
Hardware: All all
: P5 enhancement
Assignee: Michael Bien
Depends on:
Reported: 2007-10-09 03:18 CEST by Sven Gothel
Modified: 2015-09-27 03:15 CEST (History)
0 users

See Also:
SCM Refs:
Workaround: ---


Note You need to log in before you can comment on or make changes to this bug.
Description Sven Gothel 2010-03-24 07:50:53 CET

---- Reported by mbien@fh-landshut.de 2007-10-09 15:18:30 ----

The GL interface doc could be improved by adding additional to  "Entry point
(through function pointer) to C language function: ..." the doc inside the
OpenGL reference pages (http://www.opengl.org/sdk/docs/man/) for each method.

---- Additional Comments From kbr 2007-10-09 18:37:13 ----

This is already done for some of the API entry points. See
jogl/make/native-taglet.properties. Please contribute to the project by
expanding the set of functions for which these links are generated.

---- Additional Comments From mbien@fh-landshut.de 2007-10-10 09:26:47 ----

ah I see, the native-taglet.properties seems to be complete. But currently just
the function headers like void "glAccum(GLenum op, GLfloat value);" are added to
the doc. What about the rest like Parameters, Description, Notes, Errors...? The
important stuff is missing.

---- Additional Comments From kbr 2007-10-10 09:31:23 ----

These are things that could plausibly be added to the native taglet. The source
code to it is in the GlueGen workspace under src/java/net/highteq/nativetaglet/
. The code which produced the native-taglet.properties (which, by the way, isn't
complete -- it only has links for the core OpenGL functions) is I believe in the
GlueGen workspace under make/lib/JOGLDocLinksGeneratorAndLibs.jar .

Any contributions you could make in this area would be welcome.

--- Bug imported by sgothel@jausoft.com 2010-03-24 07:50 EDT  ---

This bug was previously known as _bug_ 321 at https://jogl.dev.java.net/bugs/show_bug.cgi?id=321