sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1656710 - in /sis/branches/JDK8: application/sis-console/src/main/java/org/apache/sis/console/ core/sis-feature/src/main/java/org/apache/sis/feature/ core/sis-referencing/src/main/java/org/apache/sis/geometry/ core/sis-referencing/src/main...
Date Tue, 03 Feb 2015 12:46:07 GMT
Author: desruisseaux
Date: Tue Feb  3 12:46:06 2015
New Revision: 1656710

URL: http://svn.apache.org/r1656710
Log:
Minor javadoc adjustments for slightly more uniform package descriptions.

Modified:
    sis/branches/JDK8/application/sis-console/src/main/java/org/apache/sis/console/package-info.java
    sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/FeatureFormat.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractDirectPosition.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition1D.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/ImmutableEnvelope.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/package-info.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/package-info.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Matrix1.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Matrix2.java

Modified: sis/branches/JDK8/application/sis-console/src/main/java/org/apache/sis/console/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/application/sis-console/src/main/java/org/apache/sis/console/package-info.java?rev=1656710&r1=1656709&r2=1656710&view=diff
==============================================================================
--- sis/branches/JDK8/application/sis-console/src/main/java/org/apache/sis/console/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK8/application/sis-console/src/main/java/org/apache/sis/console/package-info.java
[UTF-8] Tue Feb  3 12:46:06 2015
@@ -42,7 +42,7 @@
  * The {@code com.sun.management.jmxremote.local.only} property is recommended if the remote
JVM is an other
  * JVM instance running on the local machine. Otherwise this property can be omitted for
debugging purpose.
  * For production environment, see the security settings documented on the
- * <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/management/agent.html">Monitoring
+ * <a href="http://docs.oracle.com/javase/8/docs/technotes/guides/management/agent.html">Monitoring
  * and Management Using JMX Technology</a> page.
  *
  * @author  Martin Desruisseaux (Geomatys)

Modified: sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/FeatureFormat.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/FeatureFormat.java?rev=1656710&r1=1656709&r2=1656710&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/FeatureFormat.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/FeatureFormat.java
[UTF-8] Tue Feb  3 12:46:06 2015
@@ -43,7 +43,7 @@ import org.opengis.feature.Operation;
 
 
 /**
- * Formats {@link AbstractFeature features} or {@linkplain DefaultFeatureType feature types}
in a tabular format.
+ * Formats {@linkplain AbstractFeature features} or {@linkplain DefaultFeatureType feature
types} in a tabular format.
  * This format assumes a monospaced font and an encoding supporting drawing box characters
(e.g. UTF-8).
  *
  * <div class="note"><b>Example:</b> a feature named “City” and containing
3 properties (“name”, “population” and

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractDirectPosition.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractDirectPosition.java?rev=1656710&r1=1656709&r2=1656710&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractDirectPosition.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractDirectPosition.java
[UTF-8] Tue Feb  3 12:46:06 2015
@@ -45,6 +45,8 @@ import java.util.Objects;
 
 /**
  * Base class for {@link DirectPosition} implementations.
+ * A direct position holds the coordinates for a position within some
+ * {@linkplain org.apache.sis.referencing.crs.AbstractCRS coordinate reference system}.
  * This base class provides default implementations for {@link #toString()},
  * {@link #equals(Object)} and {@link #hashCode()} methods.
  *
@@ -390,7 +392,7 @@ parse:  while (i < length) {
             final int dimension = getDimension();
             if (dimension == that.getDimension()) {
                 for (int i=0; i<dimension; i++) {
-                    if (doubleToLongBits(getOrdinate(i)) != doubleToLongBits(that.getOrdinate(i)))
{
+                    if (!Numerics.equals(getOrdinate(i), that.getOrdinate(i))) {
                         return false;
                     }
                 }

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition1D.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition1D.java?rev=1656710&r1=1656709&r2=1656710&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition1D.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition1D.java
[UTF-8] Tue Feb  3 12:46:06 2015
@@ -35,7 +35,7 @@ import java.util.Objects;
 
 
 /**
- * Holds the coordinates for a one-dimensional position within some coordinate reference
system.
+ * A one-dimensional position within some coordinate reference system.
  *
  * @author  Martin Desruisseaux (IRD, Geomatys)
  * @since   0.3

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java?rev=1656710&r1=1656709&r2=1656710&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java
[UTF-8] Tue Feb  3 12:46:06 2015
@@ -33,7 +33,7 @@ import java.util.Objects;
 
 
 /**
- * Holds the coordinates for a two-dimensional position on top of {@link Point2D}.
+ * A two-dimensional position on top of {@link Point2D}.
  * This implementation is provided for inter-operability between Java2D and GeoAPI.
  *
  * <p>This class inherits {@linkplain #x x} and {@linkplain #y y} fields.

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java?rev=1656710&r1=1656709&r2=1656710&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java
[UTF-8] Tue Feb  3 12:46:06 2015
@@ -36,19 +36,20 @@ import java.util.Objects;
 
 
 /**
- * Holds the coordinates for a position within some coordinate reference system.
+ * A mutable {@code DirectPosition} (the coordinates of a position) of arbitrary dimension.
+ * This particular implementation of {@code DirectPosition} is said "General" because it
+ * uses an {@linkplain #ordinates array of ordinates} of an arbitrary length. If the direct
+ * position is known to be always two-dimensional, then {@link DirectPosition2D} provides
+ * a more efficient implementation.
+ *
+ * {@section Coordinate Reference System (CRS) optionality}
  * Since {@code DirectPosition}s, as data types, will often be included in larger objects
- * (such as {@linkplain org.opengis.geometry.Geometry geometries}) that have references
+ * (such as {@link org.opengis.geometry.Geometry}) that have references
  * to {@code CoordinateReferenceSystem}, the {@link #getCoordinateReferenceSystem()} method
  * may returns {@code null} if this particular {@code DirectPosition} is included in such
  * larger object. In this case, the coordinate reference system is implicitly assumed to
take
  * on the value of the containing object's {@code CoordinateReferenceSystem}.
  *
- * <p>This particular implementation of {@code DirectPosition} is said "General" because
it
- * uses an {@linkplain #ordinates array of ordinates} of an arbitrary length. If the direct
- * position is known to be always two-dimensional, then {@link DirectPosition2D} provides
- * a more efficient implementation.</p>
- *
  * @author  Martin Desruisseaux (IRD, Geomatys)
  * @since   0.3
  * @version 0.3

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java?rev=1656710&r1=1656709&r2=1656710&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java
[UTF-8] Tue Feb  3 12:46:06 2015
@@ -41,10 +41,10 @@ import static org.apache.sis.math.MathFu
 
 
 /**
- * A minimum bounding box or rectangle. Regardless of dimension, an {@code Envelope} can
- * be represented without ambiguity as two {@linkplain DirectPosition direct positions}
- * (coordinate points). To encode an {@code Envelope}, it is sufficient to encode these
- * two points.
+ * A mutable {@code Envelope} (a minimum bounding box or rectangle) of arbitrary dimension.
+ * Regardless of dimension, an {@code Envelope} can be represented without ambiguity
+ * as two {@linkplain AbstractDirectPosition direct positions} (coordinate points).
+ * To encode an {@code Envelope}, it is sufficient to encode these two points.
  *
  * <div class="note"><b>Note:</b>
  * {@code Envelope} uses an arbitrary <cite>Coordinate Reference System</cite>,
which does not need to be geographic.

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/ImmutableEnvelope.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/ImmutableEnvelope.java?rev=1656710&r1=1656709&r2=1656710&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/ImmutableEnvelope.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/ImmutableEnvelope.java
[UTF-8] Tue Feb  3 12:46:06 2015
@@ -33,7 +33,7 @@ import static org.apache.sis.util.Argume
 
 
 /**
- * Immutable representation of an {@linkplain Envelope envelope}.
+ * An immutable {@code Envelope} (a minimum bounding box or rectangle) of arbitrary dimension.
  * This class is final in order to ensure that the immutability contract can not be broken
  * (assuming not using <cite>Java Native Interface</cite> or reflections).
  *

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/package-info.java?rev=1656710&r1=1656709&r2=1656710&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/package-info.java
[UTF-8] Tue Feb  3 12:46:06 2015
@@ -16,7 +16,7 @@
  */
 
 /**
- * Coordinate reference system definitions as coordinate systems related to the earth through
datum.
+ * Coordinate Reference System (CRS) definitions as coordinate systems related to the earth
through datum.
  * An explanation for this package is provided in the {@linkplain org.opengis.referencing.crs
OpenGIS® javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/package-info.java?rev=1656710&r1=1656709&r2=1656710&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/package-info.java
[UTF-8] Tue Feb  3 12:46:06 2015
@@ -16,7 +16,7 @@
  */
 
 /**
- * Coordinate system definitions as the set of coordinate system axes that spans the coordinate
space.
+ * Coordinate System (CS) definitions as the set of coordinate system axes that spans the
coordinate space.
  * An explanation for this package is provided in the {@linkplain org.opengis.referencing.cs
OpenGIS® javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Matrix1.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Matrix1.java?rev=1656710&r1=1656709&r2=1656710&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Matrix1.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Matrix1.java
[UTF-8] Tue Feb  3 12:46:06 2015
@@ -22,7 +22,7 @@ import org.apache.sis.internal.util.Nume
 
 /**
  * A matrix of fixed {@value #SIZE}×{@value #SIZE} size,
- * typically resulting from {@linkplain org.opengis.referencing.operation.MathTransform1D}
derivative computation.
+ * typically resulting from {@link org.opengis.referencing.operation.MathTransform1D} derivative
computation.
  * The matrix member is:
  *
  * <blockquote><pre> ┌     ┐

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Matrix2.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Matrix2.java?rev=1656710&r1=1656709&r2=1656710&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Matrix2.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Matrix2.java
[UTF-8] Tue Feb  3 12:46:06 2015
@@ -22,7 +22,7 @@ import org.apache.sis.internal.util.Nume
 
 /**
  * A matrix of fixed {@value #SIZE}×{@value #SIZE} size,
- * typically resulting from {@linkplain org.opengis.referencing.operation.MathTransform2D}
derivative computation.
+ * typically resulting from {@link org.opengis.referencing.operation.MathTransform2D} derivative
computation.
  * The matrix members are:
  *
  * <blockquote><pre> ┌         ┐



Mime
View raw message