[Arakhnê-Dev] [416] * Update the javadoc.

[subversion@xxxxxxxxxxxxx]

Revision: 416
Author:   galland
Date:     2013-04-08 11:06:20 +0200 (Mon, 08 Apr 2013)
Log Message:
-----------
* Update the javadoc.

Modified Paths:
--------------
    trunk/math/src/main/java/org/arakhne/afc/math/MathUtil.java

Modified: trunk/math/src/main/java/org/arakhne/afc/math/MathUtil.java
===================================================================
--- trunk/math/src/main/java/org/arakhne/afc/math/MathUtil.java	2013-04-06 07:41:09 UTC (rev 415)
+++ trunk/math/src/main/java/org/arakhne/afc/math/MathUtil.java	2013-04-08 09:06:20 UTC (rev 416)
@@ -751,6 +751,10 @@
 	 *  order to point at the specified point {@code (px,py)}.
 	 * In other words, given three point P1, P2, and P, is the segments (P1-P2-P) a counterclockwise turn?
 	 * <p>
+	 * In opposite to {@link #sidePointLine(float, float, float, float, float, float, boolean)},
+	 * this function tries to classifies the point if it is colinear to the segment.
+	 * The classification is explained below.
+	 * <p>
 	 * A return value of 1 indicates that the line segment must turn in the direction that takes the 
 	 * positive X axis towards the negative Y axis. In the default coordinate system used by Java 2D, 
 	 * this direction is counterclockwise.
@@ -781,8 +785,8 @@
 	 * @param approximateZero
 	 *            indicates if zero may be approximated or not.
 	 * @return an integer that indicates the position of the third specified coordinates with respect to the line segment formed by the first two specified coordinates.
-	 * @see #ccw(float, float, float, float, float, float) 
 	 * @see #relativeDistancePointToLine(float, float, float, float, float, float)
+	 * @see #sidePointLine(float, float, float, float, float, float, boolean)
 	 */
 	public static int ccw(float x1, float y1, float x2, float y2, float px, float py, boolean approximateZero) {
 		float cx2 = x2 - x1;
@@ -829,6 +833,10 @@
 	 * A return value of 0 indicates that the point lies exactly on the line segment. Note that an indicator value of 0 is rare and not useful for determining colinearity because of floating point rounding issues.
 	 * <p>
 	 * This function uses the equal-to-zero test with the error {@link #EPSILON}.
+	 * <p>
+	 * In opposite of {@link #ccw(float, float, float, float, float, float, boolean)},
+	 * this function does not try to classify the point if it is colinear
+	 * to the segment. If the point is colinear, O is always returns. 
 	 * 
 	 * @param x1
 	 *            the X coordinate of the start point of the specified line segment
@@ -847,6 +855,7 @@
 	 * @return an integer that indicates the position of the third specified coordinates with respect to the line segment formed by the first two specified coordinates.
 	 * @see #relativeDistancePointToLine(float, float, float, float, float, float)
 	 * @see #isEpsilonZero(float)
+	 * @see #ccw(float, float, float, float, float, float, boolean)
 	 */
 	public static int sidePointLine(float x1, float y1, float x2, float y2, float px, float py, boolean approximateZero) {
 		float cx2 = x2 - x1;