Issue number:

Obtained from:
Submitted by:   Travis
Reviewed by:


These are all documentation changes in preparation for the Proposed Final
Draft submission.

Carefully separated out references to the implementation from the
specification.  Did not delete any comments, just made sure that it was
clear when it was the Reference Implementation being referred to.

Add note to Spec Overview about version information.  We now include
version information in the manifest of the jar file and we require
this of all implementations.  This is currently done automatically
as part of the build process and is easy to access at runtime with
the java.lang.Package APIs.


git-svn-id: file:///usr/local/projects/SUN/JOGL/git-svn/svn-server-sync/jogl/trunk@592 232f8b59-042b-4e1e-8c03-345bb8c30851

3 files changed, 16 insertions, 12 deletions

diff --git a/src/classes/javax/media/opengl/GLEventListener.java b/src/classes/javax/media/opengl/GLEventListener.java
index 3aadbf833..2f4d3ac72 100644
--- a/src/classes/javax/media/opengl/GLEventListener.java
+++ b/src/classes/javax/media/opengl/GLEventListener.java
@@ -76,8 +76,7 @@ public interface GLEventListener extends EventListener {
 
   /** Called by the drawable when the display mode or the display device
       associated with the GLAutoDrawable has changed. The two boolean parameters
-      indicate the types of change(s) that have occurred. (<b> !!! CURRENTLY
-      UNIMPLEMENTED !!! </b>)
+      indicate the types of change(s) that have occurred. 
       <P>
 
       An example of a display <i>mode</i> change is when the bit depth changes (e.g.,
@@ -90,10 +89,13 @@ public interface GLEventListener extends EventListener {
 
       The reason that this function handles both types of changes (instead of
       handling mode and device changes in separate methods) is so that
-      applications have the opportunity to respond to display changes the most
+      applications have the opportunity to respond to display changes in the most
       efficient manner. For example, the application may need make fewer
       adjustments to compensate for a device change if it knows that the mode
-      on the new device is identical the previous mode.
+      on the new device is identical the previous mode.<p>
+
+      <b>NOTE: Implementations are not required to implement this method.  The
+        Reference Implementation DOES NOT IMPLEMENT this method.</b>
   */
   public void displayChanged(GLAutoDrawable drawable, boolean modeChanged, boolean deviceChanged);
 }
diff --git a/src/classes/javax/media/opengl/GLJPanel.java b/src/classes/javax/media/opengl/GLJPanel.java
index 1dd204239..6f8340aff 100644
--- a/src/classes/javax/media/opengl/GLJPanel.java
+++ b/src/classes/javax/media/opengl/GLJPanel.java
@@ -56,10 +56,16 @@ import com.sun.opengl.impl.*;
 /** A lightweight Swing component which provides OpenGL rendering
     support. Provided for compatibility with Swing user interfaces
     when adding a heavyweight doesn't work either because of
-    Z-ordering or LayoutManager problems. This component attempts to
-    use hardware-accelerated rendering via pbuffers and falls back on
-    to software rendering if problems occur. <P>
+    Z-ordering or LayoutManager problems. <P>
 
+    The GLJPanel can be made transparent by creating it with a
+    GLCapabilities object with alpha bits specified and calling {@link
+    #setOpaque}(false). Pixels with resulting OpenGL alpha values less
+    than 1.0 will be overlaid on any underlying Swing rendering. <P>
+
+    Notes specific to the Reference Implementation: This component 
+    attempts to use hardware-accelerated rendering via pbuffers and 
+    falls back on to software rendering if problems occur. 
     Note that because this component attempts to use pbuffers for
     rendering, and because pbuffers can not be resized, somewhat
     surprising behavior may occur during resize operations; the {@link
@@ -70,10 +76,6 @@ import com.sun.opengl.impl.*;
     application should attempt to make its GLEventListener.init()
     methods as side-effect-free as possible. <P>
 
-    The GLJPanel can be made transparent by creating it with a
-    GLCapabilities object with alpha bits specified and calling {@link
-    #setOpaque}(false). Pixels with resulting OpenGL alpha values less
-    than 1.0 will be overlaid on any underlying Swing rendering.
 */
 
 public class GLJPanel extends JPanel implements GLAutoDrawable {
diff --git a/src/classes/javax/media/opengl/GLPbuffer.java b/src/classes/javax/media/opengl/GLPbuffer.java
index 607c5c9fa..04cf7f0ed 100644
--- a/src/classes/javax/media/opengl/GLPbuffer.java
+++ b/src/classes/javax/media/opengl/GLPbuffer.java
@@ -45,7 +45,7 @@ package javax.media.opengl;
     contains experimental methods for accessing the pbuffer's contents
     as a texture map and enabling rendering to floating-point frame
     buffers. These methods are not guaranteed to be supported on all
-    platforms and may change or be removed in a future release. */
+    platforms and may be deprecated in a future release. */
 
 public interface GLPbuffer extends GLAutoDrawable {
   /** Indicates the GL_APPLE_float_pixels extension is being used for this pbuffer. */