[Arakhnê-Dev] [408] * Fixing javadoc.

[subversion@xxxxxxxxxxxxx]

Revision: 408
Author:   galland
Date:     2013-04-05 12:04:20 +0200 (Fri, 05 Apr 2013)
Log Message:
-----------
* Fixing 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-04 18:23:34 UTC (rev 407)
+++ trunk/math/src/main/java/org/arakhne/afc/math/MathUtil.java	2013-04-05 10:04:20 UTC (rev 408)
@@ -744,16 +744,27 @@
 	}
 
 	/**
-	 * Replies the relative counterclockwise (CCW) of a segment against a point. Returns an indicator of where the specified point {@code (px,py)} lies with respect to the line segment from {@code (x1,y1)} to {@code (x2,y2)}. The return value can be either 1, -1, or 0 and indicates in which direction the specified line must pivot around its first end point, {@code (x1,y1)}, in order to point at the specified point {@code (px,py)}.
+	 * Replies the relative counterclockwise (CCW) of a segment against a point. Returns an indicator of where 
+	 * the specified point {@code (px,py)} lies with respect to the line segment from {@code (x1,y1)}
+	 *  to {@code (x2,y2)}. The return value can be either 1, -1, or 0 and indicates in which 
+	 *  direction the specified line must pivot around its first end point, {@code (x1,y1)}, in 
+	 *  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>
-	 * 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.
+	 * 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.
 	 * <p>
-	 * A return value of -1 indicates that the line segment must turn in the direction that takes the positive X axis towards the positive Y axis. In the default coordinate system, this direction is clockwise.
+	 * A return value of -1 indicates that the line segment must turn in the direction that takes the 
+	 * positive X axis towards the positive Y axis. In the default coordinate system, this 
+	 * direction is clockwise.
 	 * <p>
-	 * 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.
+	 * 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>
-	 * If the point is colinear with the line segment, but not between the end points, then the value will be -1 if the point lies "beyond {@code (x1,y1)}" or 1 if the point lies "beyond {@code (x2,y2)}".
+	 * If the point is colinear with the line segment, but not between the end points, then the value will be 
+	 * -1 if the point lies "beyond {@code (x1,y1)}" or 1 if the point lies "beyond {@code (x2,y2)}".
 	 * 
 	 * @param x1
 	 *            the X coordinate of the start point of the specified line segment
@@ -770,6 +781,7 @@
 	 * @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)
 	 */
 	public static int ccw(float x1, float y1, float x2, float y2, float px, float py, boolean approximateZero) {