Skip to content

Commit

Permalink
Refactor mentions of specific vector classes in JavaDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
httpdigest committed Jul 25, 2023
1 parent 72c45e4 commit 422242d
Show file tree
Hide file tree
Showing 8 changed files with 60 additions and 60 deletions.
16 changes: 8 additions & 8 deletions src/main/java/org/joml/Vector2d.java
Original file line number Diff line number Diff line change
Expand Up @@ -649,7 +649,7 @@ public Vector2d mul(double scalar, Vector2d dest) {
}

/**
* Multiply the components of this Vector2d by the given scalar values and store the result in <code>this</code>.
* Multiply the components of this vector by the given scalar values and store the result in <code>this</code>.
*
* @param x
* the x component to multiply this vector by
Expand All @@ -668,7 +668,7 @@ public Vector2d mul(double x, double y, Vector2d dest) {
}

/**
* Multiply this Vector2d component-wise by another Vector2d.
* Multiply this vector component-wise by another vector.
*
* @param v
* the vector to multiply by
Expand All @@ -685,7 +685,7 @@ public Vector2d mul(Vector2dc v, Vector2d dest) {
}

/**
* Divide this Vector2d by the given scalar value.
* Divide this vector by the given scalar value.
*
* @param scalar
* the scalar to divide this vector by
Expand All @@ -703,7 +703,7 @@ public Vector2d div(double scalar, Vector2d dest) {
}

/**
* Divide the components of this Vector2d by the given scalar values and store the result in <code>this</code>.
* Divide the components of this vector by the given scalar values and store the result in <code>this</code>.
*
* @param x
* the x component to divide this vector by
Expand All @@ -722,7 +722,7 @@ public Vector2d div(double x, double y, Vector2d dest) {
}

/**
* Divide this Vector2d component-wise by another Vector2dc.
* Divide this vector component-wise by another vector.
*
* @param v
* the vector to divide by
Expand All @@ -733,7 +733,7 @@ public Vector2d div(Vector2dc v) {
}

/**
* Divide this Vector3d component-wise by another Vector2fc.
* Divide this vector component-wise by another Vector2fc.
*
* @param v
* the vector to divide by
Expand Down Expand Up @@ -794,7 +794,7 @@ public Vector2d mul(Matrix2fc mat, Vector2d dest) {
}

/**
* Multiply the transpose of the given matrix with this Vector2d and store the result in <code>this</code>.
* Multiply the transpose of the given matrix with this vector and store the result in <code>this</code>.
*
* @param mat
* the matrix
Expand All @@ -813,7 +813,7 @@ public Vector2d mulTranspose(Matrix2dc mat, Vector2d dest) {
}

/**
* Multiply the transpose of the given matrix with this Vector2d and store the result in <code>this</code>.
* Multiply the transpose of the given matrix with this vector and store the result in <code>this</code>.
*
* @param mat
* the matrix
Expand Down
14 changes: 7 additions & 7 deletions src/main/java/org/joml/Vector2dc.java
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ public interface Vector2dc {
Vector2d mul(double scalar, Vector2d dest);

/**
* Multiply the components of this Vector2d by the given scalar values and store the result in <code>dest</code>.
* Multiply the components of this vector by the given scalar values and store the result in <code>dest</code>.
*
* @param x
* the x component to multiply this vector by
Expand All @@ -185,7 +185,7 @@ public interface Vector2dc {
Vector2d mul(double x, double y, Vector2d dest);

/**
* Multiply this Vector2d component-wise by another Vector2d and store the result in <code>dest</code>.
* Multiply this vector component-wise by another vector and store the result in <code>dest</code>.
*
* @param v
* the vector to multiply by
Expand All @@ -196,7 +196,7 @@ public interface Vector2dc {
Vector2d mul(Vector2dc v, Vector2d dest);

/**
* Divide this Vector2d by the given scalar value and store the result in <code>dest</code>.
* Divide this vector by the given scalar value and store the result in <code>dest</code>.
*
* @param scalar
* the scalar to divide this vector by
Expand All @@ -207,7 +207,7 @@ public interface Vector2dc {
Vector2d div(double scalar, Vector2d dest);

/**
* Divide the components of this Vector3f by the given scalar values and store the result in <code>dest</code>.
* Divide the components of this vector by the given scalar values and store the result in <code>dest</code>.
*
* @param x
* the x component to divide this vector by
Expand All @@ -220,7 +220,7 @@ public interface Vector2dc {
Vector2d div(double x, double y, Vector2d dest);

/**
* Divide this Vector2d component-wise by another Vector2f and store the result in <code>dest</code>.
* Divide this vector component-wise by another vector and store the result in <code>dest</code>.
*
* @param v
* the vector to divide by
Expand Down Expand Up @@ -272,7 +272,7 @@ public interface Vector2dc {
Vector2d mul(Matrix2fc mat, Vector2d dest);

/**
* Multiply the transpose of the given matrix with this Vector2f and store the result in <code>dest</code>.
* Multiply the transpose of the given matrix with this vector and store the result in <code>dest</code>.
* <p>
* Note that this method performs the operation <code>M^T * this</code>, where <code>M</code> is the provided matrix
* and thus interprets <code>this</code> as a <em>column</em> vector.
Expand All @@ -286,7 +286,7 @@ public interface Vector2dc {
Vector2d mulTranspose(Matrix2dc mat, Vector2d dest);

/**
* Multiply the transpose of the given matrix with this Vector2f and store the result in <code>dest</code>.
* Multiply the transpose of the given matrix with this vector and store the result in <code>dest</code>.
* <p>
* Note that this method performs the operation <code>M^T * this</code>, where <code>M</code> is the provided matrix
* and thus interprets <code>this</code> as a <em>column</em> vector.
Expand Down
12 changes: 6 additions & 6 deletions src/main/java/org/joml/Vector2f.java
Original file line number Diff line number Diff line change
Expand Up @@ -864,7 +864,7 @@ public Vector2f mul(float scalar, Vector2f dest) {
}

/**
* Multiply the components of this Vector2f by the given scalar values and store the result in <code>this</code>.
* Multiply the components of this vector by the given scalar values and store the result in <code>this</code>.
*
* @param x
* the x component to multiply this vector by
Expand All @@ -883,7 +883,7 @@ public Vector2f mul(float x, float y, Vector2f dest) {
}

/**
* Multiply this Vector2f component-wise by another Vector2f.
* Multiply this vector component-wise by another Vector2f.
*
* @param v
* the vector to multiply by
Expand All @@ -900,7 +900,7 @@ public Vector2f mul(Vector2fc v, Vector2f dest) {
}

/**
* Divide this Vector2f component-wise by another Vector2fc.
* Divide this vector component-wise by another Vector2fc.
*
* @param v
* the vector to divide by
Expand Down Expand Up @@ -936,7 +936,7 @@ public Vector2f div(float scalar, Vector2f dest) {
}

/**
* Divide the components of this Vector2f by the given scalar values and store the result in <code>this</code>.
* Divide the components of this vector by the given scalar values and store the result in <code>this</code>.
*
* @param x
* the x component to divide this vector by
Expand All @@ -955,7 +955,7 @@ public Vector2f div(float x, float y, Vector2f dest) {
}

/**
* Multiply the given matrix with this Vector2f and store the result in <code>this</code>.
* Multiply the given matrix with this vector and store the result in <code>this</code>.
*
* @param mat
* the matrix
Expand All @@ -974,7 +974,7 @@ public Vector2f mul(Matrix2fc mat, Vector2f dest) {
}

/**
* Multiply the given matrix with this Vector2f and store the result in <code>this</code>.
* Multiply the given matrix with this vector and store the result in <code>this</code>.
*
* @param mat
* the matrix
Expand Down
14 changes: 7 additions & 7 deletions src/main/java/org/joml/Vector2fc.java
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ public interface Vector2fc {
Vector2f mul(float scalar, Vector2f dest);

/**
* Multiply the components of this Vector2f by the given scalar values and store the result in <code>dest</code>.
* Multiply the components of this vector by the given scalar values and store the result in <code>dest</code>.
*
* @param x
* the x component to multiply this vector by
Expand All @@ -300,7 +300,7 @@ public interface Vector2fc {
Vector2f mul(float x, float y, Vector2f dest);

/**
* Multiply this Vector2f component-wise by another Vector2f and store the result in <code>dest</code>.
* Multiply this vector component-wise by another vector and store the result in <code>dest</code>.
*
* @param v
* the vector to multiply by
Expand All @@ -323,7 +323,7 @@ public interface Vector2fc {
Vector2f div(float scalar, Vector2f dest);

/**
* Divide this Vector2f component-wise by another Vector2fc
* Divide this vector component-wise by another Vector2fc
* and store the result in <code>dest</code>.
*
* @param v
Expand All @@ -335,7 +335,7 @@ public interface Vector2fc {
Vector2f div(Vector2fc v, Vector2f dest);

/**
* Divide the components of this Vector2f by the given scalar values and store the result in <code>dest</code>.
* Divide the components of this vector by the given scalar values and store the result in <code>dest</code>.
*
* @param x
* the x component to divide this vector by
Expand All @@ -348,7 +348,7 @@ public interface Vector2fc {
Vector2f div(float x, float y, Vector2f dest);

/**
* Multiply the given matrix with this Vector2f and store the result in <code>dest</code>.
* Multiply the given matrix with this vector and store the result in <code>dest</code>.
* <p>
* Note that this method performs the operation <code>M * this</code>, where <code>M</code> is the provided matrix
* and thus interprets <code>this</code> as a <em>column</em> vector.
Expand All @@ -362,7 +362,7 @@ public interface Vector2fc {
Vector2f mul(Matrix2fc mat, Vector2f dest);

/**
* Multiply the given matrix with this Vector2f and store the result in <code>dest</code>.
* Multiply the given matrix with this vector and store the result in <code>dest</code>.
* <p>
* Note that this method performs the operation <code>M * this</code>, where <code>M</code> is the provided matrix
* and thus interprets <code>this</code> as a <em>column</em> vector.
Expand All @@ -376,7 +376,7 @@ public interface Vector2fc {
Vector2f mul(Matrix2dc mat, Vector2f dest);

/**
* Multiply the transpose of the given matrix with this Vector3f and store the result in <code>dest</code>.
* Multiply the transpose of the given matrix with this vector and store the result in <code>dest</code>.
* <p>
* Note that this method performs the operation <code>M^T * this</code>, where <code>M</code> is the provided matrix
* and thus interprets <code>this</code> as a <em>column</em> vector.
Expand Down
20 changes: 10 additions & 10 deletions src/main/java/org/joml/Vector3d.java
Original file line number Diff line number Diff line change
Expand Up @@ -925,7 +925,7 @@ public Vector3d mulAdd(Vector3fc a, Vector3dc b, Vector3d dest) {
}

/**
* Multiply this Vector3d component-wise by another Vector3dc.
* Multiply this vector component-wise by another Vector3dc.
*
* @param v
* the vector to multiply by
Expand All @@ -936,7 +936,7 @@ public Vector3d mul(Vector3dc v) {
}

/**
* Multiply this Vector3d component-wise by another Vector3fc.
* Multiply this vector component-wise by another Vector3fc.
*
* @param v
* the vector to multiply by
Expand All @@ -961,7 +961,7 @@ public Vector3d mul(Vector3dc v, Vector3d dest) {
}

/**
* Divide this Vector3d component-wise by another Vector3dc.
* Divide this vector component-wise by another Vector3dc.
*
* @param v
* the vector to divide by
Expand All @@ -972,7 +972,7 @@ public Vector3d div(Vector3dc v) {
}

/**
* Divide this Vector3d component-wise by another Vector3fc.
* Divide this vector component-wise by another Vector3fc.
*
* @param v
* the vector to divide by
Expand Down Expand Up @@ -1263,7 +1263,7 @@ public Vector3d mul(Matrix3fc mat, Vector3d dest) {
}

/**
* Multiply the given matrix with this Vector3d by assuming a third row in the matrix of <code>(0, 0, 1)</code>
* Multiply the given matrix with this vector by assuming a third row in the matrix of <code>(0, 0, 1)</code>
* and store the result in <code>this</code>.
*
* @param mat
Expand All @@ -1284,7 +1284,7 @@ public Vector3d mul(Matrix3x2dc mat, Vector3d dest) {
}

/**
* Multiply the given matrix with this Vector3d by assuming a third row in the matrix of <code>(0, 0, 1)</code>
* Multiply the given matrix with this vector by assuming a third row in the matrix of <code>(0, 0, 1)</code>
* and store the result in <code>this</code>.
*
* @param mat
Expand Down Expand Up @@ -1892,7 +1892,7 @@ public Vector3d mulTransposeDirection(Matrix4fc mat, Vector3d dest) {
}

/**
* Multiply this Vector3d by the given scalar value.
* Multiply this vector by the given scalar value.
*
* @param scalar
* the scalar to multiply this vector by
Expand All @@ -1910,7 +1910,7 @@ public Vector3d mul(double scalar, Vector3d dest) {
}

/**
* Multiply the components of this Vector3d by the given scalar values and store the result in <code>this</code>.
* Multiply the components of this vector by the given scalar values and store the result in <code>this</code>.
*
* @param x
* the x component to multiply this vector by
Expand Down Expand Up @@ -2067,7 +2067,7 @@ public Vector3d rotateZ(double angle, Vector3d dest) {
}

/**
* Divide this Vector3d by the given scalar value.
* Divide this vector by the given scalar value.
*
* @param scalar
* the scalar to divide this vector by
Expand All @@ -2086,7 +2086,7 @@ public Vector3d div(double scalar, Vector3d dest) {
}

/**
* Divide the components of this Vector3d by the given scalar values and store the result in <code>this</code>.
* Divide the components of this vector by the given scalar values and store the result in <code>this</code>.
*
* @param x
* the x component to divide this vector by
Expand Down
12 changes: 6 additions & 6 deletions src/main/java/org/joml/Vector3dc.java
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ public interface Vector3dc {
Vector3d mulAdd(Vector3fc a, Vector3dc b, Vector3d dest);

/**
* Multiply this Vector3d component-wise by another Vector3f and store the result in <code>dest</code>.
* Multiply this vector component-wise by another vector and store the result in <code>dest</code>.
*
* @param v
* the vector to multiply by
Expand All @@ -412,7 +412,7 @@ public interface Vector3dc {
Vector3d mul(Vector3dc v, Vector3d dest);

/**
* Divide this Vector3d component-wise by another Vector3f and store the result in <code>dest</code>.
* Divide this vector component-wise by another vector and store the result in <code>dest</code>.
*
* @param v
* the vector to divide by
Expand Down Expand Up @@ -1094,7 +1094,7 @@ public interface Vector3dc {
Vector3d mulTransposeDirection(Matrix4fc mat, Vector3d dest);

/**
* Multiply this Vector3d by the given scalar value and store the result in <code>dest</code>.
* Multiply this vector by the given scalar value and store the result in <code>dest</code>.
*
* @param scalar
* the scalar factor
Expand All @@ -1105,7 +1105,7 @@ public interface Vector3dc {
Vector3d mul(double scalar, Vector3d dest);

/**
* Multiply the components of this Vector3f by the given scalar values and store the result in <code>dest</code>.
* Multiply the components of this vector by the given scalar values and store the result in <code>dest</code>.
*
* @param x
* the x component to multiply this vector by
Expand Down Expand Up @@ -1227,7 +1227,7 @@ public interface Vector3dc {
Vector3d rotateZ(double angle, Vector3d dest);

/**
* Divide this Vector3d by the given scalar value and store the result in <code>dest</code>.
* Divide this vector by the given scalar value and store the result in <code>dest</code>.
*
* @param scalar
* the scalar to divide this vector by
Expand All @@ -1238,7 +1238,7 @@ public interface Vector3dc {
Vector3d div(double scalar, Vector3d dest);

/**
* Divide the components of this Vector3f by the given scalar values and store the result in <code>dest</code>.
* Divide the components of this vector by the given scalar values and store the result in <code>dest</code>.
*
* @param x
* the x component to divide this vector by
Expand Down
Loading

0 comments on commit 422242d

Please sign in to comment.