Răsfoiți Sursa

correct the javadoc of toString() methods (5 files in com.jme3.math)

Stephen Gold 5 ani în urmă
părinte
comite
1e7c95cbb8

+ 10 - 6
jme3-core/src/main/java/com/jme3/math/Matrix3f.java

@@ -1152,12 +1152,16 @@ public final class Matrix3f implements Savable, Cloneable, java.io.Serializable
     }
 
     /**
-     * <code>toString</code> returns the string representation of this object.
-     * It is in a format of a 3x3 matrix. For example, an identity matrix would
-     * be represented by the following string. com.jme.math.Matrix3f <br>[<br>
-     * 1.0  0.0  0.0 <br>
-     * 0.0  1.0  0.0 <br>
-     * 0.0  0.0  1.0 <br>]<br>
+     * <code>toString</code> returns a string representation of this matrix.
+     * For example, an identity matrix would be represented by:
+     * <pre>
+     * Matrix3f
+     * [
+     *  1.0  0.0  0.0
+     *  0.0  1.0  0.0
+     *  0.0  0.0  1.0
+     * ]
+     * <pre>
      *
      * @return the string representation of this object.
      */

+ 11 - 7
jme3-core/src/main/java/com/jme3/math/Matrix4f.java

@@ -2231,13 +2231,17 @@ public final class Matrix4f implements Savable, Cloneable, java.io.Serializable
     }
 
     /**
-     * <code>toString</code> returns the string representation of this object.
-     * It is in a format of a 4x4 matrix. For example, an identity matrix would
-     * be represented by the following string. com.jme.math.Matrix3f <br>[<br>
-     * 1.0  0.0  0.0  0.0 <br>
-     * 0.0  1.0  0.0  0.0 <br>
-     * 0.0  0.0  1.0  0.0 <br>
-     * 0.0  0.0  0.0  1.0 <br>]<br>
+     * <code>toString</code> returns a string representation of this matrix.
+     * For example, an identity matrix would be represented by:
+     * <pre>
+     * Matrix4f
+     * [
+     *  1.0  0.0  0.0  0.0
+     *  0.0  1.0  0.0  0.0
+     *  0.0  0.0  1.0  0.0
+     *  0.0  0.0  0.0  1.0
+     * ]
+     * </pre>
      *
      * @return the string representation of this object.
      */

+ 4 - 5
jme3-core/src/main/java/com/jme3/math/Plane.java

@@ -280,11 +280,10 @@ public class Plane implements Savable, Cloneable, java.io.Serializable {
     }
 
     /**
-     * <code>toString</code> returns a string that represents the string
-     * representation of this plane. It represents the normal as a
-     * <code>Vector3f</code> object, so the format is the following:
-     * com.jme.math.Plane [Normal: org.jme.math.Vector3f [X=XX.XXXX, Y=YY.YYYY,
-     * Z=ZZ.ZZZZ] - Constant: CC.CCCCC]
+     * <code>toString</code> returns a string representation of this plane.
+     * It represents the normal as a <code>Vector3f</code>, so the format is:
+     *
+     * Plane [Normal: (X.XXXX, Y.YYYY, Z.ZZZZ) - Constant: C.CCCC]
      *
      * @return the string representation of this plane.
      */

+ 4 - 3
jme3-core/src/main/java/com/jme3/math/Vector2f.java

@@ -724,9 +724,10 @@ public final class Vector2f implements Savable, Cloneable, java.io.Serializable
     }
 
     /**
-     * <code>toString</code> returns the string representation of this vector
-     * object. The format of the string is such: com.jme.math.Vector2f
-     * [X=XX.XXXX, Y=YY.YYYY]
+     * <code>toString</code> returns a string representation of this vector.
+     * The format is:
+     *
+     * (XX.XXXX, YY.YYYY)
      *
      * @return the string representation of this vector.
      */

+ 2 - 2
jme3-core/src/main/java/com/jme3/math/Vector3f.java

@@ -1015,10 +1015,10 @@ public final class Vector3f implements Savable, Cloneable, java.io.Serializable
     }
 
     /**
-     * <code>toString</code> returns the string representation of this vector.
+     * <code>toString</code> returns a string representation of this vector.
      * The format is:
      *
-     * org.jme.math.Vector3f [X=XX.XXXX, Y=YY.YYYY, Z=ZZ.ZZZZ]
+     * (XX.XXXX, YY.YYYY, ZZ.ZZZZ)
      *
      * @return the string representation of this vector.
      */