diff options
author | Sven Gothel <[email protected]> | 2012-10-17 08:08:09 +0200 |
---|---|---|
committer | Sven Gothel <[email protected]> | 2012-10-17 08:08:09 +0200 |
commit | 1b327874356130096546533a690deff3b7bc876c (patch) | |
tree | 4504b618f051e1ffab25d3110ec4c34756c242fb /src | |
parent | 83cc52571ffeeea8efc673ed274a4c7a09597c6c (diff) |
Minor NEWT Display/Screen API doc
Diffstat (limited to 'src')
-rw-r--r-- | src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java | 4 | ||||
-rw-r--r-- | src/newt/classes/com/jogamp/newt/Display.java | 6 | ||||
-rw-r--r-- | src/newt/classes/com/jogamp/newt/Screen.java | 8 |
3 files changed, 10 insertions, 8 deletions
diff --git a/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java b/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java index 057f28487..85156e8a1 100644 --- a/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java +++ b/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java @@ -500,8 +500,8 @@ public abstract class GLAutoDrawableBase implements GLAutoDrawable, FPSCounter { /** * @param t the thread for which context release shall be skipped, usually the animation thread, * ie. {@link Animator#getThread()}. - * @deprecated this is an experimental feature, - * intended for measuring performance in regards to GL context switch + * @deprecated This is an experimental feature, + * intended for measuring performance in regards to GL context switch. */ @Deprecated public void setSkipContextReleaseThread(Thread t) { diff --git a/src/newt/classes/com/jogamp/newt/Display.java b/src/newt/classes/com/jogamp/newt/Display.java index de1d58068..e97dec88d 100644 --- a/src/newt/classes/com/jogamp/newt/Display.java +++ b/src/newt/classes/com/jogamp/newt/Display.java @@ -88,7 +88,7 @@ public abstract class Display { public abstract boolean isNativeValid(); /** - * @return number of references by Screen + * @return number of references */ public abstract int getReferenceCount(); @@ -96,7 +96,7 @@ public abstract class Display { * The 1st call will initiate native creation, * since we follow the lazy creation pattern. * - * @return number of references after adding one + * @return number of references post operation * @throws NativeWindowException if the native creation failed. * @see #removeReference() */ @@ -106,7 +106,7 @@ public abstract class Display { * The last call may destroy this instance, * if {@link #getDestroyWhenUnused()} returns <code>true</code>. * - * @return number of references after removing one + * @return number of references post operation * @see #addReference() * @see #getDestroyWhenUnused() * @see #setDestroyWhenUnused(boolean) diff --git a/src/newt/classes/com/jogamp/newt/Screen.java b/src/newt/classes/com/jogamp/newt/Screen.java index cfbcc988a..a09748d52 100644 --- a/src/newt/classes/com/jogamp/newt/Screen.java +++ b/src/newt/classes/com/jogamp/newt/Screen.java @@ -89,13 +89,14 @@ public abstract class Screen { public abstract boolean isNativeValid(); /** - * @return number of references by Window + * @return number of references */ public abstract int getReferenceCount(); /** * See {@link Display#addReference()} - * + * + * @return number of references post operation * @throws NativeWindowException if the native creation failed. * @see #removeReference() * @see #setDestroyWhenUnused(boolean) @@ -105,7 +106,8 @@ public abstract class Screen { /** * See {@link Display#removeReference()} - * + * + * @return number of references post operation * @see #addReference() * @see #setDestroyWhenUnused(boolean) * @see #getDestroyWhenUnused() |