fixed a bunch of javadoc warnings.

7 files changed, 57 insertions, 58 deletions

diff --git a/src/jogl/classes/com/jogamp/opengl/util/ImmModeSink.java b/src/jogl/classes/com/jogamp/opengl/util/ImmModeSink.java
index 126a303ab..ad230a415 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/ImmModeSink.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/ImmModeSink.java
@@ -35,8 +35,8 @@ public class ImmModeSink {
    * a ShaderState must be current, using ShaderState.glUseProgram().
    *
    * @see #draw(GL, boolean)
-   * @see javax.media.opengl.glsl.ShaderState#glUseProgram(GL2ES2, boolean)
-   * @see javax.media.opengl.glsl.ShaderState#getCurrent()
+   * @see com.jogamp.opengl.util.glsl.ShaderState#glUseProgram(GL2ES2, boolean)
+   * @see com.jogamp.opengl.util.glsl.ShaderState#getCurrent()
    */
   public static ImmModeSink createGLSL(GL gl, int glBufferUsage, int initialSize,
                                        int vComps, int vDataType,
diff --git a/src/jogl/classes/com/jogamp/opengl/util/PMVMatrix.java b/src/jogl/classes/com/jogamp/opengl/util/PMVMatrix.java
index f6d5f1999..4ca8ff197 100755
--- a/src/jogl/classes/com/jogamp/opengl/util/PMVMatrix.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/PMVMatrix.java
@@ -295,7 +295,7 @@ public class PMVMatrix implements GLMatrixFunc {
     }
 
   /**
-   * @param pname GL_MODELVIEW, GL_PROJECTION or GL.GL_TEXTURE
+   * @param matrixName GL_MODELVIEW, GL_PROJECTION or GL.GL_TEXTURE
    * @return the given matrix
    */
     public final FloatBuffer glGetMatrixf(final int matrixName) {
diff --git a/src/jogl/classes/com/jogamp/opengl/util/TGAWriter.java b/src/jogl/classes/com/jogamp/opengl/util/TGAWriter.java
index c53cafdcb..b949f0e39 100755
--- a/src/jogl/classes/com/jogamp/opengl/util/TGAWriter.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/TGAWriter.java
@@ -42,13 +42,11 @@ import java.nio.channels.*;
 
 /**
  * Utility class which helps take fast screenshots of OpenGL rendering
- * results into Targa-format files. Used by the {@link
- * com.jogamp.opengl.util.gl2.Screenshot Screenshot} class; can also be used
- * in conjunction with the {@link com.jogamp.opengl.util.gl2.TileRenderer
- * TileRenderer} class. <P>
+ * results into Targa-format files. Used by the {@link com.jogamp.opengl.util.awt.Screenshot}
+ * class; can also be used in conjunction with the {@link com.jogamp.opengl.util.gl2.TileRenderer} class.
  */
-
 public class TGAWriter {
+    
   private static final int TARGA_HEADER_SIZE = 18;
 
   private FileChannel ch;
diff --git a/src/jogl/classes/com/jogamp/opengl/util/glsl/ShaderProgram.java b/src/jogl/classes/com/jogamp/opengl/util/glsl/ShaderProgram.java
index 49a341cc6..430ed08ce 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/glsl/ShaderProgram.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/glsl/ShaderProgram.java
@@ -5,7 +5,6 @@ import javax.media.opengl.*;
 
 import java.util.HashMap;
 import java.util.Iterator;
-import java.nio.*;
 import java.io.PrintStream;
 
 public class ShaderProgram {
@@ -104,16 +103,20 @@ public class ShaderProgram {
      * Refetches all previously bin/get attribute names
      * and resets all attribute data as well
      *
-     * @see getAttribLocation
      * @param gl 
      * @param oldShaderID the to be replace Shader
      * @param newShader   the new ShaderCode
      * @param verboseOut  the optional verbose outputstream
      * @throws GLException is the program is not linked
      *
-     * @see #glRefetchAttribLocations
-     * @see #glResetAllVertexAttributes
-     * @see #glReplaceShader
+     * @see ShaderState#glEnableVertexAttribArray
+     * @see ShaderState#glDisableVertexAttribArray
+     * @see ShaderState#glVertexAttribPointer
+     * @see ShaderState#getVertexAttribPointer
+     * @see ShaderState#glReleaseAllVertexAttributes
+     * @see ShaderState#glResetAllVertexAttributes
+     * @see ShaderState#glResetAllVertexAttributes
+     * @see ShaderState#glResetAllVertexAttributes
      */
     public synchronized boolean glReplaceShader(GL2ES2 gl, int oldShaderID, ShaderCode newShader, PrintStream verboseOut) {
         if(!programLinked) throw new GLException("Program is not linked");
diff --git a/src/jogl/classes/com/jogamp/opengl/util/glsl/ShaderState.java b/src/jogl/classes/com/jogamp/opengl/util/glsl/ShaderState.java
index 33f6e210b..86f9251b7 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/glsl/ShaderState.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/glsl/ShaderState.java
@@ -2,14 +2,11 @@
 package com.jogamp.opengl.util.glsl;
 
 import javax.media.opengl.*;
-import com.jogamp.opengl.util.*;
 import com.jogamp.opengl.impl.Debug;
 
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Iterator;
-import java.nio.*;
-import java.io.PrintStream;
 import java.security.*;
 
 public class ShaderState {
@@ -25,8 +22,8 @@ public class ShaderState {
     /**
      * Fetches the current shader state from the thread local storage (TLS)
      *
-     * @see javax.media.opengl.glsl.ShaderState#glUseProgram(GL2ES2, boolean)
-     * @see javax.media.opengl.glsl.ShaderState#getCurrent()
+     * @see com.jogamp.opengl.util.glsl.ShaderState#glUseProgram(GL2ES2, boolean)
+     * @see com.jogamp.opengl.util.glsl.ShaderState#getCurrent()
      */
     public static synchronized ShaderState getCurrent() { 
         GLContext current = GLContext.getCurrent();
@@ -41,8 +38,8 @@ public class ShaderState {
      * Puts this ShaderState to to the thread local storage (TLS),
      * if <code>on</code> is <code>true</code>.
      *
-     * @see javax.media.opengl.glsl.ShaderState#glUseProgram(GL2ES2, boolean)
-     * @see javax.media.opengl.glsl.ShaderState#getCurrent()
+     * @see com.jogamp.opengl.util.glsl.ShaderState#glUseProgram(GL2ES2, boolean)
+     * @see com.jogamp.opengl.util.glsl.ShaderState#getCurrent()
      */
     public synchronized void glUseProgram(GL2ES2 gl, boolean on) {
         if(on) {
@@ -178,7 +175,7 @@ public class ShaderState {
      * @see #glGetAttribLocation
      * @see javax.media.opengl.GL2ES2#glGetAttribLocation
      * @see #getAttribLocation
-     * @see #glReplaceShader
+     * @see ShaderProgram#glReplaceShader
      */
     public void glBindAttribLocation(GL2ES2 gl, int index, String name) {
         if(null==shaderProgram) throw new GLException("No program is attached");
@@ -203,7 +200,7 @@ public class ShaderState {
      * @see #glGetAttribLocation
      * @see javax.media.opengl.GL2ES2#glGetAttribLocation
      * @see #getAttribLocation
-     * @see #glReplaceShader
+     * @see ShaderProgram#glReplaceShader
      */
     public int glGetAttribLocation(GL2ES2 gl, String name) {
         if(!shaderProgram.linked()) throw new GLException("Program is not linked");
@@ -240,17 +237,17 @@ public class ShaderState {
      * Even if the attribute is not found in the current shader,
      * it is stored in this state.
      *
-     * @returns false, if the name is not found, otherwise true
+     * @return false, if the name is not found, otherwise true
      *
      * @throws GLException if the program is not in use
      *
      * @see #glEnableVertexAttribArray
      * @see #glDisableVertexAttribArray
      * @see #glVertexAttribPointer
-     * @see #getVertexAttributePointer
+     * @see #getVertexAttribPointer
      * @see #glReleaseAllVertexAttributes
      * @see #glResetAllVertexAttributes
-     * @see #glReplaceShader
+     * @see ShaderProgram#glReplaceShader
      */
     public boolean glEnableVertexAttribArray(GL2ES2 gl, String name) {
         if(!shaderProgram.inUse()) throw new GLException("Program is not in use");
@@ -281,17 +278,17 @@ public class ShaderState {
      * Even if the attribute is not found in the current shader,
      * it is removed from this state.
      *
-     * @returns false, if the name is not found, otherwise true
+     * @return false, if the name is not found, otherwise true
      *
      * @throws GLException if the program is not in use
      *
      * @see #glEnableVertexAttribArray
      * @see #glDisableVertexAttribArray
      * @see #glVertexAttribPointer
-     * @see #getVertexAttributePointer
+     * @see #getVertexAttribPointer
      * @see #glReleaseAllVertexAttributes
      * @see #glResetAllVertexAttributes
-     * @see #glReplaceShader
+     * @see ShaderProgram#glReplaceShader
      */
     public boolean glDisableVertexAttribArray(GL2ES2 gl, String name) {
         if(!shaderProgram.inUse()) throw new GLException("Program is not in use");
@@ -322,17 +319,17 @@ public class ShaderState {
      *      it's index will be set with the attribute's location,
      *      if found.
      *
-     * @returns false, if the name is not found, otherwise true
+     * @return false, if the name is not found, otherwise true
      *
      * @throws GLException if the program is not in use
      *
      * @see #glEnableVertexAttribArray
      * @see #glDisableVertexAttribArray
      * @see #glVertexAttribPointer
-     * @see #getVertexAttributePointer
+     * @see #getVertexAttribPointer
      * @see #glReleaseAllVertexAttributes
      * @see #glResetAllVertexAttributes
-     * @see #glReplaceShader
+     * @see ShaderProgram#glReplaceShader
      */
     public boolean glVertexAttribPointer(GL2ES2 gl, GLArrayData data) {
         if(!shaderProgram.inUse()) throw new GLException("Program is not in use");
@@ -367,15 +364,15 @@ public class ShaderState {
     /**
      * Get the vertex attribute data, previously set.
      *
-     * @returns the GLArrayData object, null if not previously set.
+     * @return the GLArrayData object, null if not previously set.
      *
      * @see #glEnableVertexAttribArray
      * @see #glDisableVertexAttribArray
      * @see #glVertexAttribPointer
-     * @see #getVertexAttributePointer
+     * @see #getVertexAttribPointer
      * @see #glReleaseAllVertexAttributes
      * @see #glResetAllVertexAttributes
-     * @see #glReplaceShader
+     * @see ShaderProgram#glReplaceShader
      */
     public GLArrayData getVertexAttribPointer(String name) {
         return (GLArrayData) vertexAttribMap2Data.get(name);
@@ -390,11 +387,11 @@ public class ShaderState {
      * @see #glEnableVertexAttribArray
      * @see #glDisableVertexAttribArray
      * @see #glVertexAttribPointer
-     * @see #getVertexAttributePointer
+     * @see #getVertexAttribPointer
      * @see #glReleaseAllVertexAttributes
      * @see #glResetAllVertexAttributes
      * @see #glResetAllVertexAttributes
-     * @see #glReplaceShader
+     * @see ShaderProgram#glReplaceShader
      */
     public void glReleaseAllVertexAttributes(GL2ES2 gl) {
         if(null!=shaderProgram) {
@@ -428,11 +425,11 @@ public class ShaderState {
      * @see #glEnableVertexAttribArray
      * @see #glDisableVertexAttribArray
      * @see #glVertexAttribPointer
-     * @see #getVertexAttributePointer
+     * @see #getVertexAttribPointer
      * @see #glReleaseAllVertexAttributes
      * @see #glResetAllVertexAttributes
      * @see #glResetAllVertexAttributes
-     * @see #glReplaceShader
+     * @see ShaderProgram#glReplaceShader
      */
     public void glDisableAllVertexAttributeArrays(GL2ES2 gl, boolean removeFromState) {
         if(!shaderProgram.inUse()) throw new GLException("Program is not in use");
@@ -458,10 +455,10 @@ public class ShaderState {
      * @see #glEnableVertexAttribArray
      * @see #glDisableVertexAttribArray
      * @see #glVertexAttribPointer
-     * @see #getVertexAttributePointer
+     * @see #getVertexAttribPointer
      * @see #glReleaseAllVertexAttributes
      * @see #glResetAllVertexAttributes
-     * @see #glReplaceShader
+     * @see ShaderProgram#glReplaceShader
      */
     public void glResetAllVertexAttributes(GL2ES2 gl) {
         if(!shaderProgram.inUse()) throw new GLException("Program is not in use");
@@ -520,7 +517,7 @@ public class ShaderState {
      * @see #glGetUniformLocation
      * @see javax.media.opengl.GL2ES2#glGetUniformLocation
      * @see #getUniformLocation
-     * @see #glReplaceShader
+     * @see ShaderProgram#glReplaceShader
      */
     protected int glGetUniformLocation(GL2ES2 gl, String name) {
         if(!shaderProgram.inUse()) throw new GLException("Program is not in use");
@@ -554,14 +551,14 @@ public class ShaderState {
      *      if found.
      *
      *
-     * @returns false, if the name is not found, otherwise true
+     * @return false, if the name is not found, otherwise true
      *
      * @throws GLException if the program is not in use
      *
      * @see #glGetUniformLocation
      * @see javax.media.opengl.GL2ES2#glGetUniformLocation
      * @see #getUniformLocation
-     * @see #glReplaceShader
+     * @see ShaderProgram#glReplaceShader
      */
     public boolean glUniform(GL2ES2 gl, GLUniformData data) {
         if(!shaderProgram.inUse()) throw new GLException("Program is not in use");
@@ -581,7 +578,7 @@ public class ShaderState {
     /**
      * Get the uniform data, previously set.
      *
-     * @returns the GLUniformData object, null if not previously set.
+     * @return the GLUniformData object, null if not previously set.
      */
     public GLUniformData getUniform(String name) {
         return (GLUniformData) uniformMap2Data.get(name);
diff --git a/src/jogl/classes/com/jogamp/opengl/util/glsl/fixedfunc/FixedFuncUtil.java b/src/jogl/classes/com/jogamp/opengl/util/glsl/fixedfunc/FixedFuncUtil.java
index a7042c47a..f00357bfb 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/glsl/fixedfunc/FixedFuncUtil.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/glsl/fixedfunc/FixedFuncUtil.java
@@ -66,25 +66,25 @@ public class FixedFuncUtil {
 
     /**
      * String name for
-     * @see javax.media.opengl.GL#GL_VERTEX_ARRAY
+     * @see javax.media.opengl.GL2#GL_VERTEX_ARRAY
      */
     public static final String mgl_Vertex = FixedFuncPipeline.mgl_Vertex;
 
     /**
      * String name for
-     * @see javax.media.opengl.GL#GL_NORMAL_ARRAY
+     * @see javax.media.opengl.GL2#GL_NORMAL_ARRAY
      */
     public static final String mgl_Normal = FixedFuncPipeline.mgl_Normal;
 
     /**
      * String name for
-     * @see javax.media.opengl.GL#GL_COLOR_ARRAY
+     * @see javax.media.opengl.GL2#GL_COLOR_ARRAY
      */
     public static final String mgl_Color = FixedFuncPipeline.mgl_Color;
 
     /**
      * String name for
-     * @see javax.media.opengl.GL#GL_TEXTURE_COORD_ARRAY
+     * @see javax.media.opengl.GL2#GL_TEXTURE_COORD_ARRAY
      */
     public static final String mgl_MultiTexCoord = FixedFuncPipeline.mgl_MultiTexCoord;
 }
diff --git a/src/jogl/classes/com/jogamp/opengl/util/glsl/sdk/CompileShader.java b/src/jogl/classes/com/jogamp/opengl/util/glsl/sdk/CompileShader.java
index 9741da737..a0eed50ea 100755
--- a/src/jogl/classes/com/jogamp/opengl/util/glsl/sdk/CompileShader.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/glsl/sdk/CompileShader.java
@@ -7,16 +7,17 @@ import com.jogamp.opengl.util.glsl.*;
 import java.io.*;
 import java.net.*;
 
-/** Precompiles a shader into a vendor binary format. Input is the
-    resource name of the shader, such as
-    "com/jogamp/opengl/impl/glsl/fixed/shader/a.fp".
-    Output is "com/jogamp/opengl/impl/glsl/fixed/shader/bin/nvidia/a.bfp".
-
-    All path and suffixes are determined by the ShaderCode class,
-    which ensures runtime compatibility.
-
-    @see javax.media.opengl.glsl.ShaderCode
-  */
+/**
+ * Precompiles a shader into a vendor binary format. Input is the
+ * resource name of the shader, such as
+ * "com/jogamp/opengl/impl/glsl/fixed/shader/a.fp".
+ * Output is "com/jogamp/opengl/impl/glsl/fixed/shader/bin/nvidia/a.bfp".
+ *
+ * All path and suffixes are determined by the ShaderCode class,
+ * which ensures runtime compatibility.
+ *
+ * @see com.jogamp.opengl.util.glsl.ShaderCode
+ */
 
 public abstract class CompileShader {