Some javadoc fixes.

This commit is contained in:
Michael Bayne
2012-05-11 11:16:51 -07:00
parent fb74b7d2a8
commit 65c870a0fe
6 changed files with 16 additions and 14 deletions
+2 -2
View File
@@ -45,8 +45,8 @@ public class Box implements IBox, Serializable
}
/**
* Sets the parameters of the box to the empty values ({@link Vector3f#MAX_VALUE} and
* {@link Vector3f#MIN_VALUE} for the minimum and maximum, respectively).
* Sets the parameters of the box to the empty values ({@link Vector3#MAX_VALUE} and
* {@link Vector3#MIN_VALUE} for the minimum and maximum, respectively).
*
* @return a reference to this box, for chaining.
*/
+5 -4
View File
@@ -32,9 +32,9 @@ public interface IQuaternion
boolean hasNaN ();
/**
* Computes the angles to pass to {@link #fromAngles} to reproduce this rotation, placing them
* in the provided vector. This uses the factorization method described in David Eberly's
* <a href="http://www.geometrictools.com/Documentation/EulerAngles.pdf">Euler Angle
* Computes the angles to pass to {@link Quaternion#fromAngles} to reproduce this rotation,
* placing them in the provided vector. This uses the factorization method described in David
* Eberly's <a href="http://www.geometrictools.com/Documentation/EulerAngles.pdf">Euler Angle
* Formulas</a>.
*
* @return a reference to the result vector, for chaining.
@@ -42,7 +42,8 @@ public interface IQuaternion
Vector3 toAngles (Vector3 result);
/**
* Computes and returns the angles to pass to {@link #fromAngles} to reproduce this rotation.
* Computes and returns the angles to pass to {@link Quaternion#fromAngles} to reproduce this
* rotation.
*
* @return a new vector containing the resulting angles.
*/
+1 -1
View File
@@ -471,7 +471,7 @@ public class Matrix3 implements IMatrix3, Serializable
}
/**
* @{@inheritDoc} This code is based on the examples in the
* {@inheritDoc} This code is based on the examples in the
* <a href="http://www.j3d.org/matrix_faq/matrfaq_latest.html">Matrix and Quaternion FAQ</a>.
*/
@Override // from IMatrix3
+2 -2
View File
@@ -45,8 +45,8 @@ public class Box implements IBox, Serializable
}
/**
* Sets the parameters of the box to the empty values ({@link Vector3f#MAX_VALUE} and
* {@link Vector3f#MIN_VALUE} for the minimum and maximum, respectively).
* Sets the parameters of the box to the empty values ({@link Vector3#MAX_VALUE} and
* {@link Vector3#MIN_VALUE} for the minimum and maximum, respectively).
*
* @return a reference to this box, for chaining.
*/
+5 -4
View File
@@ -32,9 +32,9 @@ public interface IQuaternion
boolean hasNaN ();
/**
* Computes the angles to pass to {@link #fromAngles} to reproduce this rotation, placing them
* in the provided vector. This uses the factorization method described in David Eberly's
* <a href="http://www.geometrictools.com/Documentation/EulerAngles.pdf">Euler Angle
* Computes the angles to pass to {@link Quaternion#fromAngles} to reproduce this rotation,
* placing them in the provided vector. This uses the factorization method described in David
* Eberly's <a href="http://www.geometrictools.com/Documentation/EulerAngles.pdf">Euler Angle
* Formulas</a>.
*
* @return a reference to the result vector, for chaining.
@@ -42,7 +42,8 @@ public interface IQuaternion
Vector3 toAngles (Vector3 result);
/**
* Computes and returns the angles to pass to {@link #fromAngles} to reproduce this rotation.
* Computes and returns the angles to pass to {@link Quaternion#fromAngles} to reproduce this
* rotation.
*
* @return a new vector containing the resulting angles.
*/
+1 -1
View File
@@ -471,7 +471,7 @@ public class Matrix3 implements IMatrix3, Serializable
}
/**
* @{@inheritDoc} This code is based on the examples in the
* {@inheritDoc} This code is based on the examples in the
* <a href="http://www.j3d.org/matrix_faq/matrfaq_latest.html">Matrix and Quaternion FAQ</a>.
*/
@Override // from IMatrix3