diff options
author | Julien Gouesse <[email protected]> | 2019-06-04 00:06:24 +0200 |
---|---|---|
committer | Julien Gouesse <[email protected]> | 2019-06-04 00:06:24 +0200 |
commit | 0b5bb174e1414ce5730f5acd3c2d1647b4dd31c3 (patch) | |
tree | e805a8256940fb8dae77ad0444756bbc9f1ef0d1 /ardor3d-math/src/main/java/com/ardor3d | |
parent | 2252e0644a90246b47b7be3b125e82ed0c958668 (diff) |
Fixes some errors in the Java documentation of ardor3d-math
Diffstat (limited to 'ardor3d-math/src/main/java/com/ardor3d')
5 files changed, 39 insertions, 4 deletions
diff --git a/ardor3d-math/src/main/java/com/ardor3d/math/Rectangle2.java b/ardor3d-math/src/main/java/com/ardor3d/math/Rectangle2.java index 9a62e1b..fe2174a 100644 --- a/ardor3d-math/src/main/java/com/ardor3d/math/Rectangle2.java +++ b/ardor3d-math/src/main/java/com/ardor3d/math/Rectangle2.java @@ -43,11 +43,20 @@ public class Rectangle2 implements Cloneable, Savable, Externalizable, ReadOnlyR /** * Constructor creates a new <code>Rectangle2</code> with its origin at 0,0 and width/height of 0. */ - public Rectangle2() {} + public Rectangle2() { + } /** * Constructor creates a new <code>Rectangle2</code> with using the given x,y,width and height values. * + * @param x + * the x value + * @param y + * the y value + * @param width + * the width + * @param height + * the height */ public Rectangle2(final int x, final int y, final int width, final int height) { setX(x); @@ -234,7 +243,9 @@ public class Rectangle2 implements Cloneable, Savable, Externalizable, ReadOnlyR * @param in * ObjectInput * @throws IOException + * if something wrong occurs while reading * @throws ClassNotFoundException + * if a class is not found */ @Override public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException { @@ -250,6 +261,7 @@ public class Rectangle2 implements Cloneable, Savable, Externalizable, ReadOnlyR * @param out * ObjectOutput * @throws IOException + * if something wrong occurs while writing */ @Override public void writeExternal(final ObjectOutput out) throws IOException { diff --git a/ardor3d-math/src/main/java/com/ardor3d/math/Rectangle3.java b/ardor3d-math/src/main/java/com/ardor3d/math/Rectangle3.java index 2010f8d..b98d1d4 100644 --- a/ardor3d-math/src/main/java/com/ardor3d/math/Rectangle3.java +++ b/ardor3d-math/src/main/java/com/ardor3d/math/Rectangle3.java @@ -40,7 +40,8 @@ public class Rectangle3 implements Cloneable, Savable, Externalizable, ReadOnlyR /** * Constructor creates a new Rectangle3 with corners at origin. */ - public Rectangle3() {} + public Rectangle3() { + } /** * Constructor creates a new Rectangle3 using the values of the provided source rectangle. @@ -247,7 +248,9 @@ public class Rectangle3 implements Cloneable, Savable, Externalizable, ReadOnlyR * @param in * ObjectInput * @throws IOException + * if something wrong occurs while reading * @throws ClassNotFoundException + * if a class is not found */ @Override public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException { @@ -262,6 +265,7 @@ public class Rectangle3 implements Cloneable, Savable, Externalizable, ReadOnlyR * @param out * ObjectOutput * @throws IOException + * if something wrong occurs while writing */ @Override public void writeExternal(final ObjectOutput out) throws IOException { diff --git a/ardor3d-math/src/main/java/com/ardor3d/math/Transform.java b/ardor3d-math/src/main/java/com/ardor3d/math/Transform.java index 1be57e8..bd1e974 100644 --- a/ardor3d-math/src/main/java/com/ardor3d/math/Transform.java +++ b/ardor3d-math/src/main/java/com/ardor3d/math/Transform.java @@ -81,6 +81,7 @@ public class Transform implements Cloneable, Savable, Externalizable, ReadOnlyTr * Constructs a new Transform object from the information stored in the given source Transform. * * @param source + * the source transform * @throws NullPointerException * if source is null. */ @@ -656,7 +657,8 @@ public class Transform implements Cloneable, Savable, Externalizable, ReadOnlyTr // In all remaining cases, the matrix cannot be written as R*S*X+T. final ReadOnlyMatrix3 matrixA = isRotationMatrix() - ? _matrix.multiplyDiagonalPost(_scale, Matrix3.fetchTempInstance()) : _matrix; + ? _matrix.multiplyDiagonalPost(_scale, Matrix3.fetchTempInstance()) + : _matrix; final ReadOnlyMatrix3 matrixB = transformBy.isRotationMatrix() ? transformBy.getMatrix().multiplyDiagonalPost(transformBy.getScale(), Matrix3.fetchTempInstance()) diff --git a/ardor3d-math/src/main/java/com/ardor3d/math/Triangle.java b/ardor3d-math/src/main/java/com/ardor3d/math/Triangle.java index 454a43e..2b1d489 100644 --- a/ardor3d-math/src/main/java/com/ardor3d/math/Triangle.java +++ b/ardor3d-math/src/main/java/com/ardor3d/math/Triangle.java @@ -48,7 +48,8 @@ public class Triangle implements Cloneable, Savable, Externalizable, ReadOnlyTri /** * Construct a new, mutable triangle with all points at 0,0,0 and an index of 0. */ - public Triangle() {} + public Triangle() { + } /** * Copy constructor. @@ -64,8 +65,11 @@ public class Triangle implements Cloneable, Savable, Externalizable, ReadOnlyTri * Construct a new, mutable triangle using the given points and an index of 0. * * @param pointA + * the point A * @param pointB + * the point B * @param pointC + * the point C */ public Triangle(final ReadOnlyVector3 pointA, final ReadOnlyVector3 pointB, final ReadOnlyVector3 pointC) { this(pointA, pointB, pointC, 0); @@ -75,9 +79,13 @@ public class Triangle implements Cloneable, Savable, Externalizable, ReadOnlyTri * Constructs a new triangle using the given points and index. * * @param pointA + * the point A * @param pointB + * the point B * @param pointC + * the point C * @param index + * the index */ public Triangle(final ReadOnlyVector3 pointA, final ReadOnlyVector3 pointB, final ReadOnlyVector3 pointC, final int index) { @@ -91,6 +99,7 @@ public class Triangle implements Cloneable, Savable, Externalizable, ReadOnlyTri * Copies the values of the given source Triangle into this Triangle. * * @param source + * the source triangle * @return this Triangle for chaining * @throws NullPointerException * if source is null. @@ -168,6 +177,7 @@ public class Triangle implements Cloneable, Savable, Externalizable, ReadOnlyTri * Sets the index value of this triangle to the given int value. * * @param index + * the index to set */ public void setIndex(final int index) { _index = index; @@ -177,6 +187,7 @@ public class Triangle implements Cloneable, Savable, Externalizable, ReadOnlyTri * Sets the first point of this triangle to the values of the given vector. * * @param pointA + * the point A to set */ public void setA(final ReadOnlyVector3 pointA) { _pointA.set(pointA); @@ -187,6 +198,7 @@ public class Triangle implements Cloneable, Savable, Externalizable, ReadOnlyTri * Sets the second point of this triangle to the values of the given vector. * * @param pointB + * the point B to set */ public void setB(final ReadOnlyVector3 pointB) { _pointB.set(pointB); @@ -197,6 +209,7 @@ public class Triangle implements Cloneable, Savable, Externalizable, ReadOnlyTri * Sets the third point of this triangle to the values of the given vector. * * @param pointC + * the point C to set */ public void setC(final ReadOnlyVector3 pointC) { _pointC.set(pointC); @@ -355,7 +368,9 @@ public class Triangle implements Cloneable, Savable, Externalizable, ReadOnlyTri * @param in * ObjectInput * @throws IOException + * if something wrong occurs while reading * @throws ClassNotFoundException + * if a class is not found */ @Override public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException { @@ -371,6 +386,7 @@ public class Triangle implements Cloneable, Savable, Externalizable, ReadOnlyTri * @param out * ObjectOutput * @throws IOException + * if something wrong occurs while writing */ @Override public void writeExternal(final ObjectOutput out) throws IOException { diff --git a/ardor3d-math/src/main/java/com/ardor3d/math/Vector2.java b/ardor3d-math/src/main/java/com/ardor3d/math/Vector2.java index c5757a5..c881f64 100644 --- a/ardor3d-math/src/main/java/com/ardor3d/math/Vector2.java +++ b/ardor3d-math/src/main/java/com/ardor3d/math/Vector2.java @@ -222,6 +222,7 @@ public class Vector2 implements Cloneable, Savable, Externalizable, ReadOnlyVect * Sets the value of this vector to the (x, y) values of the provided source vector. * * @param source + * the source vector * @return this vector for chaining * @throws NullPointerException * if source is null. |