From 1c5758f1e006e51d7a64ed3ea35f7485419e094f Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Thu, 9 Oct 2014 13:07:12 +0200
Subject: Graph/Math: Fix minor apidoc issues

---
 src/jogl/classes/com/jogamp/graph/curve/opengl/GLRegion.java     | 8 +++++---
 .../classes/com/jogamp/graph/curve/opengl/RegionRenderer.java    | 9 +++++++++
 2 files changed, 14 insertions(+), 3 deletions(-)

(limited to 'src/jogl/classes/com/jogamp/graph/curve')

diff --git a/src/jogl/classes/com/jogamp/graph/curve/opengl/GLRegion.java b/src/jogl/classes/com/jogamp/graph/curve/opengl/GLRegion.java
index 8f3a10d9d..654f9a692 100644
--- a/src/jogl/classes/com/jogamp/graph/curve/opengl/GLRegion.java
+++ b/src/jogl/classes/com/jogamp/graph/curve/opengl/GLRegion.java
@@ -37,6 +37,7 @@ import jogamp.graph.curve.opengl.VBORegionSPES2;
 import com.jogamp.opengl.util.PMVMatrix;
 import com.jogamp.opengl.util.texture.TextureSequence;
 import com.jogamp.graph.curve.Region;
+import com.jogamp.graph.curve.OutlineShape;
 
 /** A GLRegion is the OGL binding of one or more OutlineShapes
  *  Defined by its vertices and generated triangles. The Region
@@ -46,7 +47,8 @@ import com.jogamp.graph.curve.Region;
  *  Implementations of the GLRegion shall take care of the OGL
  *  binding of the depending on its context, profile.
  *
- * @see Region, RegionFactory, OutlineShape
+ * @see Region
+ * @see OutlineShape
  */
 public abstract class GLRegion extends Region {
 
@@ -118,7 +120,7 @@ public abstract class GLRegion extends Region {
      * it afterwards when used in conjunction with other renderer.
      * </p>
      * <p>
-     * Users shall also consider setting the {@link GL#glClearColor(float, float, float, float) Clear Color}
+     * Users shall also consider setting the {@link GL#glClearColor(float, float, float, float) clear-color}
      * appropriately:
      * <ul>
      *   <li>If {@link GL#GL_BLEND blending} is enabled, <i>RGB</i> shall be set to text color, otherwise
@@ -129,7 +131,7 @@ public abstract class GLRegion extends Region {
      * Note: If {@link GL#GL_BLEND blending} is enabled, the
      * {@link RegionRenderer} might need to be
      * {@link RegionRenderer#create(RenderState, com.jogamp.graph.curve.opengl.RegionRenderer.GLCallback, com.jogamp.graph.curve.opengl.RegionRenderer.GLCallback) created}
-     * with the appropriate {@link {@link RegionRenderer.GLCallback callbacks}.
+     * with the appropriate {@link RegionRenderer.GLCallback callbacks}.
      * </p>
      * @param matrix current {@link PMVMatrix}.
      * @param renderer the {@link RegionRenderer} to be used
diff --git a/src/jogl/classes/com/jogamp/graph/curve/opengl/RegionRenderer.java b/src/jogl/classes/com/jogamp/graph/curve/opengl/RegionRenderer.java
index 23b82639f..a0f54d3b5 100644
--- a/src/jogl/classes/com/jogamp/graph/curve/opengl/RegionRenderer.java
+++ b/src/jogl/classes/com/jogamp/graph/curve/opengl/RegionRenderer.java
@@ -59,6 +59,15 @@ public class RegionRenderer {
     protected static final boolean DEBUG = Region.DEBUG;
     protected static final boolean DEBUG_INSTANCE = Region.DEBUG_INSTANCE;
 
+    /**
+     * May be passed to
+     * {@link RegionRenderer#create(RenderState, com.jogamp.graph.curve.opengl.RegionRenderer.GLCallback, com.jogamp.graph.curve.opengl.RegionRenderer.GLCallback) RegionRenderer ctor},
+     * e.g.
+     * <ul>
+     *   <li>{@link RegionRenderer#defaultBlendEnable}</li>
+     *   <li>{@link RegionRenderer#defaultBlendDisable}</li>
+     * </ul>
+     */
     public interface GLCallback {
         /**
          * @param gl a current GL object
-- 
cgit v1.2.3