Fix Javadocs of Matrix4/4x3.shadow()

JOML-CI · Aug 23, 2021 · 56ebda4 · 56ebda4
1 parent 0565642
commit 56ebda4
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 32 deletions.
diff --git a/src/org/joml/Matrix4d.java b/src/org/joml/Matrix4d.java
@@ -14017,7 +14017,7 @@ private Vector3d originGeneric(Vector3d dest) {
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -14050,7 +14050,7 @@ public Matrix4d shadow(Vector4dc light, double a, double b, double c, double d,
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -14157,7 +14157,7 @@ public Matrix4d shadow(Vector4dc light, Matrix4dc planeTransform, Matrix4d dest)
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param light
      *          the light's vector
@@ -14189,7 +14189,7 @@ public Matrix4d shadow(double lightX, double lightY, double lightZ, double light
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param lightX
      *          the x-component of the light vector

diff --git a/src/org/joml/Matrix4dc.java b/src/org/joml/Matrix4dc.java
@@ -4962,7 +4962,7 @@ Matrix4d mul3x3(
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -4992,7 +4992,7 @@ Matrix4d mul3x3(
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -5030,7 +5030,7 @@ Matrix4d mul3x3(
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param light
      *          the light's vector
@@ -5054,7 +5054,7 @@ Matrix4d mul3x3(
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param lightX
      *          the x-component of the light vector

diff --git a/src/org/joml/Matrix4f.java b/src/org/joml/Matrix4f.java
@@ -12807,7 +12807,7 @@ private Vector3f originGeneric(Vector3f dest) {
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -12840,7 +12840,7 @@ public Matrix4f shadow(Vector4f light, float a, float b, float c, float d, Matri
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -12947,7 +12947,7 @@ public Matrix4f shadow(Vector4f light, Matrix4fc planeTransform, Matrix4f dest)
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param light
      *          the light's vector
@@ -12979,7 +12979,7 @@ public Matrix4f shadow(float lightX, float lightY, float lightZ, float lightW, M
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param lightX
      *          the x-component of the light vector

diff --git a/src/org/joml/Matrix4fc.java b/src/org/joml/Matrix4fc.java
@@ -4757,7 +4757,7 @@ Matrix4f mul3x3(
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -4787,7 +4787,7 @@ Matrix4f mul3x3(
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -4825,7 +4825,7 @@ Matrix4f mul3x3(
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param light
      *          the light's vector
@@ -4849,7 +4849,7 @@ Matrix4f mul3x3(
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param lightX
      *          the x-component of the light vector

diff --git a/src/org/joml/Matrix4x3d.java b/src/org/joml/Matrix4x3d.java
@@ -8673,7 +8673,7 @@ public Vector3d origin(Vector3d origin) {
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -8706,7 +8706,7 @@ public Matrix4x3d shadow(Vector4dc light, double a, double b, double c, double d
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -8807,7 +8807,7 @@ public Matrix4x3d shadow(Vector4dc light, Matrix4x3dc planeTransform, Matrix4x3d
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param light
      *          the light's vector
@@ -8839,7 +8839,7 @@ public Matrix4x3d shadow(double lightX, double lightY, double lightZ, double lig
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param lightX
      *          the x-component of the light vector

diff --git a/src/org/joml/Matrix4x3dc.java b/src/org/joml/Matrix4x3dc.java
@@ -2726,7 +2726,7 @@ public interface Matrix4x3dc {
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -2756,7 +2756,7 @@ public interface Matrix4x3dc {
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -2794,7 +2794,7 @@ public interface Matrix4x3dc {
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param light
      *          the light's vector
@@ -2818,7 +2818,7 @@ public interface Matrix4x3dc {
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param lightX
      *          the x-component of the light vector

diff --git a/src/org/joml/Matrix4x3f.java b/src/org/joml/Matrix4x3f.java
@@ -7808,7 +7808,7 @@ public Vector3f origin(Vector3f origin) {
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -7841,7 +7841,7 @@ public Matrix4x3f shadow(Vector4fc light, float a, float b, float c, float d, Ma
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -7942,7 +7942,7 @@ public Matrix4x3f shadow(Vector4fc light, Matrix4x3fc planeTransform, Matrix4x3f
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param light
      *          the light's vector
@@ -7974,7 +7974,7 @@ public Matrix4x3f shadow(float lightX, float lightY, float lightZ, float lightW,
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param lightX
      *          the x-component of the light vector

diff --git a/src/org/joml/Matrix4x3fc.java b/src/org/joml/Matrix4x3fc.java
@@ -2434,7 +2434,7 @@ public interface Matrix4x3fc {
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -2464,7 +2464,7 @@ public interface Matrix4x3fc {
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * <p>
      * Reference: <a href="ftp://ftp.sgi.com/opengl/contrib/blythe/advanced99/notes/node192.html">ftp.sgi.com</a>
      * 
@@ -2502,7 +2502,7 @@ public interface Matrix4x3fc {
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param light
      *          the light's vector
@@ -2526,7 +2526,7 @@ public interface Matrix4x3fc {
      * If <code>M</code> is <code>this</code> matrix and <code>S</code> the shadow matrix,
      * then the new matrix will be <code>M * S</code>. So when transforming a
      * vector <code>v</code> with the new matrix by using <code>M * S * v</code>, the
-     * reflection will be applied first!
+     * shadow projection will be applied first!
      * 
      * @param lightX
      *          the x-component of the light vector