svn commit: r1422460 - in /sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry: AbstractDirectPosition.java DirectPosition1D.java DirectPosition2D.java GeneralDirectPosition.java package-info.java

[de...@apache.org]

Author: desruisseaux
Date: Sun Dec 16 03:25:28 2012
New Revision: 1422460

URL: http://svn.apache.org/viewvc?rev=1422460&view=rev
Log:
Javadoc fixes.

Modified:
    sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractDirectPosition.java
    sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition1D.java
    sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java
    sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java
    sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/package-info.java

Modified: sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractDirectPosition.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractDirectPosition.java?rev=1422460&r1=1422459&r2=1422460&view=diff
==============================================================================
--- sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractDirectPosition.java (original)
+++ sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractDirectPosition.java Sun Dec 16 03:25:28 2012
@@ -32,7 +32,7 @@ import static org.apache.sis.util.String
 
 
 /**
- * Base class for {@linkplain DirectPosition direct position} implementations.
+ * Base class for {@link DirectPosition} implementations.
  * This base class provides default implementations for {@link #toString()},
  * {@link #equals(Object)} and {@link #hashCode()} methods.
  *
@@ -66,7 +66,7 @@ public abstract class AbstractDirectPosi
      *
      * <p>If this position and the given position have a non-null CRS, then the default implementation
      * requires the CRS to be {@linkplain Utilities#equalsIgnoreMetadata equals (ignoring metadata)},
-     * otherwise a {@link MismatchedReferenceSystemException} is thrown. However subclass may choose
+     * otherwise a {@code MismatchedReferenceSystemException} is thrown. However subclass may choose
      * to assign the CRS of this position to the CRS of the given position.</p>
      *
      * @param  position The new position, or {@code null}.
@@ -150,7 +150,7 @@ public abstract class AbstractDirectPosi
     /**
      * Formats this position in the <cite>Well Known Text</cite> (WKT) format.
      * The returned string is like below, where {@code x₀}, {@code x₁}, {@code x₂}, <i>etc.</i>
-     * are the {@linkplain #getOrdinate(int) ordinate} values at index 0, 1, 2, <i>etc.</i>:
+     * are the ordinate values at index 0, 1, 2, <i>etc.</i>:
      *
      * {@preformat wkt
      *   POINT(x₀ x₁ x₂ …)
@@ -292,8 +292,7 @@ parse:  while (i < length) {
 
     /**
      * Returns {@code true} if the specified object is also a {@code DirectPosition}
-     * with equal {@linkplain #getCoordinate() coordinate} and equal
-     * {@linkplain #getCoordinateReferenceSystem CRS}.
+     * with equal coordinate and equal CRS.
      *
      * This method performs the comparison as documented in the {@link DirectPosition#equals(Object)}
      * javadoc. In particular, the given object is not required to be of the same implementation class.

Modified: sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition1D.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition1D.java?rev=1422460&r1=1422459&r2=1422460&view=diff
==============================================================================
--- sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition1D.java (original)
+++ sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition1D.java Sun Dec 16 03:25:28 2012
@@ -89,7 +89,7 @@ public class DirectPosition1D extends Ab
      * @throws IllegalArgumentException If the given string can not be parsed.
      * @throws MismatchedDimensionException If the given point is not one-dimensional.
      *
-     * @see #toString(DirectPosition)
+     * @see #toString()
      * @see org.geotoolkit.measure.CoordinateFormat
      */
     public DirectPosition1D(final String wkt) throws IllegalArgumentException {

Modified: sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java?rev=1422460&r1=1422459&r2=1422460&view=diff
==============================================================================
--- sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java (original)
+++ sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java Sun Dec 16 03:25:28 2012
@@ -42,17 +42,16 @@ import static org.apache.sis.util.String
  *        For example there is no clear "x" or "y" classification for North-East direction.}
  *
  * {@section Caution when used in collections}
- * <strong>Do not mix instances of this class with ordinary {@link Point2D} instances in a
- * {@link java.util.HashSet} or as {@link java.util.HashMap} keys.</strong>
- * It is not possible to meet both {@link Point2D#hashCode} and {@link DirectPosition#hashCode}
- * contracts, and this class chooses to implements the later. Consequently, {@link #hashCode()}
- * is inconsistent with {@link Point2D#equals(Object)} but is consistent with
+ * Do not mix instances of this class with ordinary {@link Point2D} instances
+ * in a {@code HashSet} or as {@code HashMap} keys.
+ * It is not possible to meet both {@link Point2D#hashCode()} and {@link DirectPosition#hashCode()}
+ * contracts, and this class chooses to implements the later. Consequently, the {@link #hashCode()}
+ * method of this class is inconsistent with {@link Point2D#equals(Object)} but is consistent with
  * {@link DirectPosition#equals(Object)}.
  *
  * <p>In other words, it is safe to add instances of {@code DirectPosition2D} in a
  * {@code HashSet<DirectPosition>}, but it is unsafe to add them in a {@code HashSet<Point2D>}.
- * Collections that do not rely on {@link Object#hashCode()}, like {@link java.util.ArrayList},
- * are safe in all cases.</p>
+ * Collections that do not rely on hash codes, like {@code ArrayList}, are safe in all cases.</p>
  *
  * @author Martin Desruisseaux (IRD, Geomatys)
  * @since   0.3 (derived from geotk-2.0)
@@ -152,7 +151,7 @@ public class DirectPosition2D extends Po
      * @throws IllegalArgumentException If the given string can not be parsed.
      * @throws MismatchedDimensionException If the given point is not two-dimensional.
      *
-     * @see AbstractDirectPosition#toString(DirectPosition)
+     * @see #toString()
      * @see org.geotoolkit.measure.CoordinateFormat
      */
     public DirectPosition2D(final String wkt) throws IllegalArgumentException {
@@ -310,7 +309,7 @@ public class DirectPosition2D extends Po
 
     /**
      * Compares this point with the specified object for equality. If the given object implements
-     * the {@link DirectPosition} interface, then the comparison is performed as specified in the
+     * the {@code DirectPosition} interface, then the comparison is performed as specified in the
      * {@link DirectPosition#equals(Object)} contract. Otherwise the comparison is performed as
      * specified in the {@link Point2D#equals(Object)} contract.
      *

Modified: sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java?rev=1422460&r1=1422459&r2=1422460&view=diff
==============================================================================
--- sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java (original)
+++ sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java Sun Dec 16 03:25:28 2012
@@ -120,7 +120,7 @@ public class GeneralDirectPosition exten
      * @param  wkt The {@code POINT} or other kind of element to parse.
      * @throws IllegalArgumentException If the given string can not be parsed.
      *
-     * @see #toString(DirectPosition)
+     * @see #toString()
      * @see org.apache.sis.measure.CoordinateFormat
      */
     public GeneralDirectPosition(final String wkt) throws IllegalArgumentException {

Modified: sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/package-info.java?rev=1422460&r1=1422459&r2=1422460&view=diff
==============================================================================
--- sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/package-info.java (original)
+++ sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/package-info.java Sun Dec 16 03:25:28 2012
@@ -22,7 +22,7 @@
  * the CRS to a fixed number of dimensions only. The table below summarizes the most common
  * objects, and list the Java2D classes that are conceptually equivalent.
  *
- * <table class="SIS">
+ * <table class="sis">
  *   <tr>
  *     <th>Purpose</th>
  *     <th>Any dimension</th>