From 471ae0dea0666398f181baea4d4e91ca666fd46c Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Tue, 23 Apr 2013 07:53:56 +0200
Subject: Refine some API docs ..

---
 src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java    | 3 +++
 src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java         | 2 +-
 src/jogl/classes/jogamp/opengl/egl/EGLUpstreamSurfaceHook.java | 7 +++++++
 src/jogl/classes/jogamp/opengl/egl/EGLWrappedSurface.java      | 7 +++++++
 4 files changed, 18 insertions(+), 1 deletion(-)

(limited to 'src/jogl/classes')

diff --git a/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java b/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java
index 68d94d2e2..28349b250 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java
@@ -27,11 +27,13 @@
  */
 package com.jogamp.opengl.util;
 
+import javax.media.nativewindow.AbstractGraphicsDevice;
 import javax.media.opengl.GLAnimatorControl;
 import javax.media.opengl.GLAutoDrawable;
 import javax.media.opengl.GLContext;
 import javax.media.opengl.GLDrawable;
 import javax.media.opengl.GLEventListener;
+import javax.media.opengl.GLException;
 
 import com.jogamp.opengl.GLEventListenerState;
 
@@ -117,6 +119,7 @@ public class GLDrawableUtil {
    * </p>
    * @param a
    * @param b
+   * @throws GLException if the {@link AbstractGraphicsDevice} are incompatible w/ each other.
    */
   public static final void swapGLContextAndAllGLEventListener(GLAutoDrawable a, GLAutoDrawable b) {
     final GLEventListenerState gllsA = GLEventListenerState.moveFrom(a);
diff --git a/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java b/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java
index 53fe6c3c9..bfa748a54 100644
--- a/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java
+++ b/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java
@@ -103,7 +103,7 @@ public abstract class GLAutoDrawableBase implements GLAutoDrawable, GLStateKeepe
         resetFPSCounter();        
     }
    
-    /** Returns the recursive lock object of the upstream implementation, which synchronizes multithreaded access. */ 
+    /** Returns the recursive lock object of the upstream implementation, which synchronizes multithreaded access on top of {@link NativeSurface#lockSurface()}. */ 
     protected abstract RecursiveLock getLock();
 
     @Override
diff --git a/src/jogl/classes/jogamp/opengl/egl/EGLUpstreamSurfaceHook.java b/src/jogl/classes/jogamp/opengl/egl/EGLUpstreamSurfaceHook.java
index 77e9dc173..8dea10df1 100644
--- a/src/jogl/classes/jogamp/opengl/egl/EGLUpstreamSurfaceHook.java
+++ b/src/jogl/classes/jogamp/opengl/egl/EGLUpstreamSurfaceHook.java
@@ -13,6 +13,13 @@ import javax.media.opengl.GLException;
 
 import com.jogamp.nativewindow.egl.EGLGraphicsDevice;
 
+/**
+ * <pre>
+ * EGLWrappedSurface [ is_a -> WrappedSurface -> ProxySurfaceImpl -> ProxySurface -> MutableSurface -> NativeSurface] has_a
+ *     EGLUpstreamSurfaceHook [ is_a -> UpstreamSurfaceHook.MutableSize -> UpstreamSurfaceHook ] has_a
+ *        NativeSurface (i.e. native X11 surface)
+ * </pre>
+ */
 public class EGLUpstreamSurfaceHook implements UpstreamSurfaceHook.MutableSize {
     protected static final boolean DEBUG = EGLDrawableFactory.DEBUG;
     private final NativeSurface upstreamSurface;
diff --git a/src/jogl/classes/jogamp/opengl/egl/EGLWrappedSurface.java b/src/jogl/classes/jogamp/opengl/egl/EGLWrappedSurface.java
index 2c2c6cc4b..f816151c7 100644
--- a/src/jogl/classes/jogamp/opengl/egl/EGLWrappedSurface.java
+++ b/src/jogl/classes/jogamp/opengl/egl/EGLWrappedSurface.java
@@ -4,6 +4,13 @@ import javax.media.nativewindow.NativeSurface;
 
 import jogamp.nativewindow.WrappedSurface;
 
+/**
+ * <pre>
+ * EGLWrappedSurface [ is_a -> WrappedSurface -> ProxySurfaceImpl -> ProxySurface -> MutableSurface -> NativeSurface] has_a
+ *     EGLUpstreamSurfaceHook [ is_a -> UpstreamSurfaceHook.MutableSize -> UpstreamSurfaceHook ] has_a
+ *        NativeSurface (i.e. native X11 surface)
+ * </pre>
+ */
 public class EGLWrappedSurface extends WrappedSurface {
 
     public static EGLWrappedSurface get(NativeSurface surface) {
-- 
cgit v1.2.3