svn commit: r1328958 - in /commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry: euclidean/oned/OrientedPoint.java partitioning/SubHyperplane.java

[lu...@apache.org]

Author: luc
Date: Sun Apr 22 20:00:33 2012
New Revision: 1328958

URL: http://svn.apache.org/viewvc?rev=1328958&view=rev
Log:
improved javadoc

Modified:
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/oned/OrientedPoint.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/SubHyperplane.java

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/oned/OrientedPoint.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/oned/OrientedPoint.java?rev=1328958&r1=1328957&r2=1328958&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/oned/OrientedPoint.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/oned/OrientedPoint.java Sun Apr 22 20:00:33 2012
@@ -63,13 +63,12 @@ public class OrientedPoint implements Hy
      * <p>Since this class represent zero dimension spaces which does
      * not have lower dimension sub-spaces, this method returns a dummy
      * implementation of a {@link
-     * org.apache.commons.math3.geometry.partitioning.Region Region}
-     * (always the same instance). This implementation is only used to
-     * allow the {@link
+     * org.apache.commons.math3.geometry.partitioning.SubHyperplane SubHyperplane}.
+     * This implementation is only used to allow the {@link
      * org.apache.commons.math3.geometry.partitioning.SubHyperplane
      * SubHyperplane} class implementation to work properly, it should
      * <em>not</em> be used otherwise.</p>
-     * @return a dummy region
+     * @return a dummy sub hyperplane
      */
     public SubOrientedPoint wholeHyperplane() {
         return new SubOrientedPoint(this, null);

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/SubHyperplane.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/SubHyperplane.java?rev=1328958&r1=1328957&r2=1328958&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/SubHyperplane.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/SubHyperplane.java Sun Apr 22 20:00:33 2012
@@ -36,7 +36,7 @@ import org.apache.commons.math3.geometry
 public interface SubHyperplane<S extends Space> {
 
     /** Copy the instance.
-     * <p>The instance created is completely independant of the original
+     * <p>The instance created is completely independent of the original
      * one. A deep copy is used, none of the underlying objects are
      * shared (except for the nodes attributes and immutable
      * objects).</p>
@@ -62,7 +62,7 @@ public interface SubHyperplane<S extends
 
     /** Compute the relative position of the instance with respect
      * to an hyperplane.
-     * @param hyperplane hyperplane to check instane against
+     * @param hyperplane hyperplane to check instance against
      * @return one of {@link Side#PLUS}, {@link Side#MINUS}, {@link Side#BOTH},
      * {@link Side#HYPER}
      */
@@ -79,7 +79,7 @@ public interface SubHyperplane<S extends
     /** Compute the union of the instance and another sub-hyperplane.
      * @param other other sub-hyperplane to union (<em>must</em> be in the
      * same hyperplane as the instance)
-     * @return a new sub-hyperplane, union of the instane and other
+     * @return a new sub-hyperplane, union of the instance and other
      */
     SubHyperplane<S> reunite(SubHyperplane<S> other);