Fix documentation of Vector[34][fd].mulAdd() (#254)

JOML-CI · Jul 26, 2020 · d7c73af · d7c73af
1 parent 57fb50c
commit d7c73af
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 24 deletions.
diff --git a/src/org/joml/Vector3d.java b/src/org/joml/Vector3d.java
@@ -835,12 +835,13 @@ public Vector3d fma(double a, Vector3fc b, Vector3d dest) {
     }
 
     /**
-     * Add the component-wise multiplication of <code>a * b</code> to this vector.
+     * Add the component-wise multiplication of <code>this * a</code> to <code>b</code>
+     * and store the result in <code>this</code>.
      * 
      * @param a
-     *          the first multiplicand
+     *          the multiplicand
      * @param b
-     *          the second multiplicand
+     *          the addend
      * @return this
      */
     public Vector3d mulAdd(Vector3dc a, Vector3dc b) {
@@ -851,12 +852,13 @@ public Vector3d mulAdd(Vector3dc a, Vector3dc b) {
     }
 
     /**
-     * Add the component-wise multiplication of <code>a * b</code> to this vector.
+     * Add the component-wise multiplication of <code>this * a</code> to <code>b</code>
+     * and store the result in <code>this</code>.
      * 
      * @param a
-     *          the first multiplicand
+     *          the multiplicand
      * @param b
-     *          the second multiplicand
+     *          the addend
      * @return this
      */
     public Vector3d mulAdd(double a, Vector3dc b) {

diff --git a/src/org/joml/Vector3f.java b/src/org/joml/Vector3f.java
@@ -702,12 +702,13 @@ public Vector3f fma(float a, Vector3fc b, Vector3f dest) {
     }
 
     /**
-     * Add the component-wise multiplication of <code>a * b</code> to this vector.
+     * Add the component-wise multiplication of <code>this * a</code> to <code>b</code>
+     * and store the result in <code>this</code>.
      * 
      * @param a
-     *          the first multiplicand
+     *          the multiplicand
      * @param b
-     *          the second multiplicand
+     *          the addend
      * @return this
      */
     public Vector3f mulAdd(Vector3fc a, Vector3fc b) {
@@ -718,12 +719,13 @@ public Vector3f mulAdd(Vector3fc a, Vector3fc b) {
     }
 
     /**
-     * Add the component-wise multiplication of <code>a * b</code> to this vector.
+     * Add the component-wise multiplication of <code>this * a</code> to <code>b</code>
+     * and store the result in <code>this</code>.
      * 
      * @param a
-     *          the first multiplicand
+     *          the multiplicand
      * @param b
-     *          the second multiplicand
+     *          the addend
      * @return this
      */
     public Vector3f mulAdd(float a, Vector3fc b) {

diff --git a/src/org/joml/Vector4d.java b/src/org/joml/Vector4d.java
@@ -988,12 +988,13 @@ public Vector4d fma(double a, Vector4dc b, Vector4d dest) {
     }
 
     /**
-     * Add the component-wise multiplication of <code>a * b</code> to this vector.
+     * Add the component-wise multiplication of <code>this * a</code> to <code>b</code>
+     * and store the result in <code>this</code>.
      * 
      * @param a
-     *          the first multiplicand
+     *          the multiplicand
      * @param b
-     *          the second multiplicand
+     *          the addend
      * @return this
      */
     public Vector4d mulAdd(Vector4dc a, Vector4dc b) {
@@ -1004,12 +1005,13 @@ public Vector4d mulAdd(Vector4dc a, Vector4dc b) {
     }
 
     /**
-     * Add the component-wise multiplication of <code>a * b</code> to this vector.
+     * Add the component-wise multiplication of <code>this * a</code> to <code>b</code>
+     * and store the result in <code>this</code>.
      * 
      * @param a
-     *          the first multiplicand
+     *          the multiplicand
      * @param b
-     *          the second multiplicand
+     *          the addend
      * @return this
      */
     public Vector4d mulAdd(double a, Vector4dc b) {

diff --git a/src/org/joml/Vector4f.java b/src/org/joml/Vector4f.java
@@ -836,12 +836,13 @@ public Vector4f fma(float a, Vector4fc b, Vector4f dest) {
     }
 
     /**
-     * Add the component-wise multiplication of <code>a * b</code> to this vector.
+     * Add the component-wise multiplication of <code>this * a</code> to <code>b</code>
+     * and store the result in <code>this</code>.
      * 
      * @param a
-     *          the first multiplicand
+     *          the multiplicand
      * @param b
-     *          the second multiplicand
+     *          the addend
      * @return this
      */
     public Vector4f mulAdd(Vector4fc a, Vector4fc b) {
@@ -852,12 +853,13 @@ public Vector4f mulAdd(Vector4fc a, Vector4fc b) {
     }
 
     /**
-     * Add the component-wise multiplication of <code>a * b</code> to this vector.
+     * Add the component-wise multiplication of <code>this * a</code> to <code>b</code>
+     * and store the result in <code>this</code>.
      * 
      * @param a
-     *          the first multiplicand
+     *          the multiplicand
      * @param b
-     *          the second multiplicand
+     *          the addend
      * @return this
      */
     public Vector4f mulAdd(float a, Vector4fc b) {