sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1468344 - in /sis/branches/JDK7: sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/ sis-referencing/src/main/java/org/apache/sis/geometry/ sis-utility/src/main/java/org/apache/sis/util/collection/
Date Tue, 16 Apr 2013 10:00:45 GMT
Author: desruisseaux
Date: Tue Apr 16 10:00:45 2013
New Revision: 1468344

URL: http://svn.apache.org/r1468344
Log:
Javadoc fixes.

Modified:
    sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/Extents.java
    sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
    sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/Containers.java

Modified: sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/Extents.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/Extents.java?rev=1468344&r1=1468343&r2=1468344&view=diff
==============================================================================
--- sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/Extents.java
[UTF-8] (original)
+++ sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/Extents.java
[UTF-8] Tue Apr 16 10:00:45 2013
@@ -32,6 +32,8 @@ import static org.apache.sis.internal.me
  * @since   0.3 (derived from geotk-2.2)
  * @version 0.3
  * @module
+ *
+ * @see org.apache.sis.geometry.Envelopes
  */
 public final class Extents extends Static {
     /**

Modified: sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java?rev=1468344&r1=1468343&r2=1468344&view=diff
==============================================================================
--- sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
[UTF-8] (original)
+++ sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
[UTF-8] Tue Apr 16 10:00:45 2013
@@ -40,6 +40,7 @@ import static org.apache.sis.util.String
  * @version 0.3
  * @module
  *
+ * @see org.apache.sis.metadata.iso.extent.Extents
  * @see CRS
  */
 public final class Envelopes extends Static {
@@ -76,7 +77,7 @@ public final class Envelopes extends Sta
      *   <li>{@code GEOMETRYCOLLECTION(POINT(4 6),LINESTRING(3 8,7 10))}</li>
      * </ul>
      *
-     * See {@link GeneralEnvelope#GeneralEnvelope(String)} for more information about the
+     * See {@link GeneralEnvelope#GeneralEnvelope(CharSequence)} for more information about
the
      * parsing rules.
      *
      * @param  wkt The {@code BOX}, {@code POLYGON} or other kind of element to parse.
@@ -87,7 +88,7 @@ public final class Envelopes extends Sta
      * @see CRS#fromWKT(String)
      * @see org.apache.sis.io.wkt
      */
-    public static Envelope fromWKT(final String wkt) throws FactoryException {
+    public static Envelope fromWKT(final CharSequence wkt) throws FactoryException {
         ensureNonNull("wkt", wkt);
         try {
             return new GeneralEnvelope(wkt);
@@ -108,13 +109,13 @@ public final class Envelopes extends Sta
      * {@note The <code>BOX</code> element is not part of the standard <cite>Well
Known Text</cite>
      *        (WKT) format. However it is understood by many softwares, for example GDAL
and PostGIS.}
      *
-     * The string returned by this method can be {@linkplain GeneralEnvelope#GeneralEnvelope(String)
+     * The string returned by this method can be {@linkplain GeneralEnvelope#GeneralEnvelope(CharSequence)
      * parsed} by the {@code GeneralEnvelope} constructor.
      *
      * @param  envelope The envelope to format.
      * @return The envelope as a {@code BOX} or {@code BOX3D} in WKT format.
      *
-     * @see #fromWKT(String)
+     * @see #fromWKT(CharSequence)
      * @see org.apache.sis.io.wkt
      */
     public static String toString(final Envelope envelope) {
@@ -126,7 +127,7 @@ public final class Envelopes extends Sta
      * (WKT) format. {@code POLYGON} can be used as an alternative to {@code BOX} when the
element
      * needs to be considered as a standard WKT geometry.
      *
-     * <p>The string returned by this method can be {@linkplain GeneralEnvelope#GeneralEnvelope(String)
+     * <p>The string returned by this method can be {@linkplain GeneralEnvelope#GeneralEnvelope(CharSequence)
      * parsed} by the {@code GeneralEnvelope} constructor.</p>
      *
      * @param  envelope The envelope to format.

Modified: sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java?rev=1468344&r1=1468343&r2=1468344&view=diff
==============================================================================
--- sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java
[UTF-8] (original)
+++ sis/branches/JDK7/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java
[UTF-8] Tue Apr 16 10:00:45 2013
@@ -228,7 +228,7 @@ public class GeneralEnvelope extends Arr
      * @param  wkt The {@code BOX}, {@code POLYGON} or other kind of element to parse.
      * @throws IllegalArgumentException If the given string can not be parsed.
      *
-     * @see Envelopes#fromWKT(String)
+     * @see Envelopes#fromWKT(CharSequence)
      * @see Envelopes#toString(Envelope)
      */
     public GeneralEnvelope(final CharSequence wkt) throws IllegalArgumentException {
@@ -906,13 +906,13 @@ public class GeneralEnvelope extends Arr
      * For example in order to expand only the horizontal component of a four dimensional
      * (<var>x</var>,<var>y</var>,<var>z</var>,<var>t</var>)
envelope, one can use:</p>
      *
-     * {@preformat
+     * {@preformat java
      *     envelope.subEnvelope(0, 2).add(myPosition2D);
      * }
      *
      * If the sub-envelope needs to be independent from the original envelope, use the following
idiom:
      *
-     * {@preformat
+     * {@preformat java
      *     GeneralEnvelope copy = envelope.subEnvelope(0, 2).clone();
      * }
      *

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/Containers.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/Containers.java?rev=1468344&r1=1468343&r2=1468344&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/Containers.java
[UTF-8] (original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/Containers.java
[UTF-8] Tue Apr 16 10:00:45 2013
@@ -210,12 +210,12 @@ public final class Containers extends St
     }
 
     /**
-     * Returns the capacity to be given to the {@link HashMap#HashMap(int) HashMap}
+     * Returns the capacity to be given to the {@link java.util.HashMap#HashMap(int) HashMap}
      * constructor for holding the given number of elements. This method computes the capacity
      * for the default <cite>load factor</cite>, which is 0.75.
      *
-     * <p>The same calculation can be used for {@link LinkedHashMap} and
-     * {@link HashSet} as well, which are built on top of {@code HashMap}.</p>
+     * <p>The same calculation can be used for {@link java.util.LinkedHashMap} and
+     * {@link java.util.HashSet} as well, which are built on top of {@code HashMap}.</p>
      *
      * @param count The number of elements to be put into the hash map or hash set.
      * @return The minimal initial capacity to be given to the hash map constructor.



Mime
View raw message