From 60e7b83b283cc733b0c914b1f6851a23edbab3c5 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/opengl/math/FloatUtil.java | 18 +++++++++---------
 src/jogl/classes/com/jogamp/opengl/math/Ray.java       |  4 +++-
 .../classes/com/jogamp/opengl/math/geom/AABBox.java    |  6 +++++-
 .../classes/com/jogamp/opengl/math/geom/Frustum.java   | 14 +++++++++++---
 4 files changed, 28 insertions(+), 14 deletions(-)

(limited to 'src/jogl/classes/com/jogamp/opengl')

diff --git a/src/jogl/classes/com/jogamp/opengl/math/FloatUtil.java b/src/jogl/classes/com/jogamp/opengl/math/FloatUtil.java
index 3a3568697..1a8924c8f 100644
--- a/src/jogl/classes/com/jogamp/opengl/math/FloatUtil.java
+++ b/src/jogl/classes/com/jogamp/opengl/math/FloatUtil.java
@@ -42,15 +42,15 @@ import com.jogamp.opengl.math.geom.AABBox;
  * Implementation assumes linear matrix layout in column-major order
  * matching OpenGL's implementation, illustration:
  * <pre>
-  Row-Major                    Column-Major (OpenGL):
-
-        | 0  1  2  3  |            | 0  4  8  12 |
-        |             |            |             |
-        | 4  5  6  7  |            | 1  5  9  13 |
-    M = |             |        M = |             |
-        | 8  9  10 11 |            | 2  6  10 14 |
-        |             |            |             |
-        | 12 13 14 15 |            | 3  7  11 15 |
+    Row-Major                  Column-Major (OpenGL):
+
+        |  0   1   2   3 |         |  0   4   8  12 |
+        |                |         |                |
+        |  4   5   6   7 |         |  1   5   9  13 |
+    M = |                |     M = |                |
+        |  8   9  10  11 |         |  2   6  10  14 |
+        |                |         |                |
+        | 12  13  14  15 |         |  3   7  11  15 |
 
            C   R                      C   R
          m[0*4+3] = tx;             m[0+4*3] = tx;
diff --git a/src/jogl/classes/com/jogamp/opengl/math/Ray.java b/src/jogl/classes/com/jogamp/opengl/math/Ray.java
index 0daca2504..4d651d1c3 100644
--- a/src/jogl/classes/com/jogamp/opengl/math/Ray.java
+++ b/src/jogl/classes/com/jogamp/opengl/math/Ray.java
@@ -41,7 +41,9 @@ import com.jogamp.opengl.math.geom.AABBox;
  * </p>
  * <p>
  * A {@link Ray} maybe used for <i>picking</i>
- * using a {@link AABBox#getRayIntersection(Ray, float[]) bounding box}.
+ * using a {@link AABBox bounding box} via
+ * {@link AABBox#intersectsRay(Ray) fast probe} or
+ * {@link AABBox#getRayIntersection(float[], Ray, float, boolean, float[], float[], float[]) returning the intersection}.
  * </p>
  */
 public class Ray {
diff --git a/src/jogl/classes/com/jogamp/opengl/math/geom/AABBox.java b/src/jogl/classes/com/jogamp/opengl/math/geom/AABBox.java
index 4caff95ea..29cc2b51a 100644
--- a/src/jogl/classes/com/jogamp/opengl/math/geom/AABBox.java
+++ b/src/jogl/classes/com/jogamp/opengl/math/geom/AABBox.java
@@ -440,12 +440,16 @@ public class AABBox {
      *  <li>Optimized code by Pierre Terdiman, 2000 (~20-30% faster on my Celeron 500)</li>
      *  <li>Epsilon value added by Klaus Hartmann.</li>
      * </ul>
+     * </p>
+     * <p>
      * Method is based on the requirements:
      * <ul>
      *  <li>the integer representation of 0.0f is 0x00000000</li>
      *  <li>the sign bit of the float is the most significant one</li>
      * </ul>
-     * Report bugs: p.terdiman@codercorner.com
+     * </p>
+     * <p>
+     * Report bugs: p.terdiman@codercorner.com (original author)
      * </p>
      * <pre>
      * [1] http://www.codercorner.com/RayAABB.cpp
diff --git a/src/jogl/classes/com/jogamp/opengl/math/geom/Frustum.java b/src/jogl/classes/com/jogamp/opengl/math/geom/Frustum.java
index f6d3c0dfa..b73bad613 100644
--- a/src/jogl/classes/com/jogamp/opengl/math/geom/Frustum.java
+++ b/src/jogl/classes/com/jogamp/opengl/math/geom/Frustum.java
@@ -33,9 +33,17 @@ import com.jogamp.common.os.Platform;
 
 /**
  * Providing frustum {@link #getPlanes() planes} derived by different inputs
- * ({@link #updateByPMV(float[], int) P*MV}, ..)
- * used to {@link #classifySphere(float[], float) classify objects} and to test
- * whether they are {@link #isOutside(AABBox) outside}.
+ * ({@link #updateByPMV(float[], int) P*MV}, ..) used to classify objects
+ * <ul>
+ *   <li> {@link #classifyPoint(float[]) point} </li>
+ *   <li> {@link #classifySphere(float[], float) sphere} </li>
+ * </ul>
+ * and to test whether they are outside
+ * <ul>
+ *   <li> {@link #isPointOutside(float[]) point} </li>
+ *   <li> {@link #isSphereOutside(float[], float) sphere} </li>
+ *   <li> {@link #isAABBoxOutside(AABBox) bounding-box} </li>
+ * </ul>
  *
  * <p>
  * Extracting the world-frustum planes from the P*Mv:
-- 
cgit v1.2.3