sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1569913 - in /sis/branches/JDK7/core: sis-metadata/src/main/java/org/apache/sis/io/wkt/ sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/ sis-referencing/src/main/java/org/apache/sis/parameter/ sis-referencing/src/main/java/...
Date Wed, 19 Feb 2014 20:46:52 GMT
Author: desruisseaux
Date: Wed Feb 19 20:46:51 2014
New Revision: 1569913

URL: http://svn.apache.org/r1569913
Log:
Fixed javadoc warnings.

Modified:
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Colors.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Convention.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/FormattableObject.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/Citations.java
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptor.java
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValue.java
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/AbstractIdentifiedObject.java
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/AbstractCRS.java
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultEllipsoid.java
    sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/referencing/cs/HardCodedAxes.java
    sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/referencing/datum/DefaultGeodeticDatumTest.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/io/CompoundFormat.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/math/StatisticsFormat.java

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Colors.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Colors.java?rev=1569913&r1=1569912&r2=1569913&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Colors.java [UTF-8]
(original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Colors.java [UTF-8]
Wed Feb 19 20:46:51 2014
@@ -53,7 +53,7 @@ public class Colors implements Cloneable
      * Those colors give better results on a black background.
      * This map is immutable.
      *
-     * @see FormattableObject#print()
+     * @see FormattableObject#print(Convention)
      */
     public static final Colors CONSOLE = new Colors();
     static {

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Convention.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Convention.java?rev=1569913&r1=1569912&r2=1569913&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Convention.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Convention.java
[UTF-8] Wed Feb 19 20:46:51 2014
@@ -167,10 +167,8 @@ public enum Convention {
 
     /**
      * The default conventions.
-     *
-     * @todo Make final after we completed the migration from Geotk.
      */
-    static Convention DEFAULT = WKT2, DEFAULT_SIMPLIFIED = WKT2_SIMPLIFIED;
+    static final Convention DEFAULT = WKT2;
 
     /**
      * {@code true} for using WKT 1 syntax, or {@code false} for using WKT 2 syntax.

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/FormattableObject.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/FormattableObject.java?rev=1569913&r1=1569912&r2=1569913&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/FormattableObject.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/FormattableObject.java
[UTF-8] Wed Feb 19 20:46:51 2014
@@ -43,7 +43,7 @@ import org.apache.sis.internal.util.X364
  * </ul>
  *
  * {@section Syntax coloring}
- * A convenience {@link #print()} method is provided, which is roughly equivalent to
+ * A convenience {@link #print(Convention)} method is provided, which is roughly equivalent
to
  * {@code System.out.println(this)} except that syntax coloring is automatically applied
  * if the terminal seems to support the ANSI escape codes.
  *
@@ -54,7 +54,7 @@ import org.apache.sis.internal.util.X364
  * <ul>
  *   <li>{@link #toWKT()} will throw a {@link UnformattableObjectException}.</li>
  *   <li>{@link #toString()} will ignore the problem and uses non-standard elements
if needed.</li>
- *   <li>{@link #print()} will show the non-standard elements in red if syntax coloring
is enabled.</li>
+ *   <li>{@link #print(Convention)} will show the non-standard elements in red if syntax
coloring is enabled.</li>
  * </ul>
  *
  * @author  Martin Desruisseaux (IRD, Geomatys)
@@ -113,7 +113,7 @@ public abstract class FormattableObject 
      */
     @Override
     public String toString() {
-        return formatWKT(Convention.DEFAULT_SIMPLIFIED, false, false);
+        return formatWKT(Convention.WKT2_SIMPLIFIED, false, false);
     }
 
     /**

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/Citations.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/Citations.java?rev=1569913&r1=1569912&r2=1569913&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/Citations.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/Citations.java
[UTF-8] Wed Feb 19 20:46:51 2014
@@ -52,7 +52,6 @@ public final class Citations extends Sta
      * The <a href="http://www.opengeospatial.org">Open Geospatial Consortium</a>
organization.
      * "Open Geospatial Consortium" is the new name for "OpenGIS consortium".
      *
-     * @see org.apache.sis.io.wkt.Convention#OGC
      * @category Organization
      */
     public static final Citation OGC = new SimpleCitation("OGC");
@@ -79,7 +78,6 @@ public final class Citations extends Sta
      * The <a href="http://www.esri.com">ESRI</a> organization.
      * This company defines many Coordinate Reference Systems in addition to the {@linkplain
#EPSG} ones.
      *
-     * @see org.apache.sis.io.wkt.Convention#ESRI
      * @category Organization
      *
      * @since 0.4
@@ -89,7 +87,6 @@ public final class Citations extends Sta
     /**
      * The <a href="http://www.oracle.com">Oracle</a> organization.
      *
-     * @see org.apache.sis.io.wkt.Convention#ORACLE
      * @category Organization
      *
      * @since 0.4
@@ -99,7 +96,6 @@ public final class Citations extends Sta
     /**
      * The <a href="http://www.unidata.ucar.edu/software/netcdf-java">NetCDF</a>
specification.
      *
-     * @see org.apache.sis.io.wkt.Convention#NETCDF
      * @category Specification
      *
      * @since 0.4
@@ -109,7 +105,6 @@ public final class Citations extends Sta
     /**
      * The <a href="http://www.remotesensing.org/geotiff/geotiff.html">GeoTIFF</a>
specification.
      *
-     * @see org.apache.sis.io.wkt.Convention#GEOTIFF
      * @category Specification
      *
      * @since 0.4
@@ -119,7 +114,6 @@ public final class Citations extends Sta
     /**
      * The <a href="http://trac.osgeo.org/proj/">Proj.4</a> project.
      *
-     * @see org.apache.sis.io.wkt.Convention#PROJ4
      * @category Code space
      *
      * @since 0.4
@@ -136,7 +130,6 @@ public final class Citations extends Sta
      * @see #AUTO
      * @see #AUTO2
      * @see #CRS
-     * @see org.apache.sis.io.wkt.Convention#EPSG
      * @category Code space
      *
      * @since 0.4

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptor.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptor.java?rev=1569913&r1=1569912&r2=1569913&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptor.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptor.java
[UTF-8] Wed Feb 19 20:46:51 2014
@@ -72,7 +72,7 @@ import java.util.Objects;
  * @version 0.4
  * @module
  *
- * @see Parameter
+ * @see DefaultParameterValue
  * @see DefaultParameterDescriptorGroup
  */
 public class DefaultParameterDescriptor<T> extends AbstractIdentifiedObject implements
ParameterDescriptor<T> {

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValue.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValue.java?rev=1569913&r1=1569912&r2=1569913&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValue.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValue.java
[UTF-8] Wed Feb 19 20:46:51 2014
@@ -324,8 +324,6 @@ public class DefaultParameterValue<T> ex
 
     /**
      * Returns the converter to be used by {@link #doubleValue(Unit)} and {@link #doubleValueList(Unit)}.
-     *
-     * @see #getConverterFrom(Unit)
      */
     private UnitConverter getConverterTo(final Unit<?> unit) {
         final Unit<?> source = getUnit();

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/AbstractIdentifiedObject.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/AbstractIdentifiedObject.java?rev=1569913&r1=1569912&r2=1569913&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/AbstractIdentifiedObject.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/AbstractIdentifiedObject.java
[UTF-8] Wed Feb 19 20:46:51 2014
@@ -980,7 +980,8 @@ public class AbstractIdentifiedObject ex
      * {@section Formatting non-standard WKT}
      * If the implementation can not represent this object without violating some WKT constraints,
      * it can uses its own (non-standard) keywords but shall declare that it did so by invoking
one
-     * of the {@link Formatter#setInvalidWKT(IdentifiedObject) Formatter.setInvalidWKT(…)}
methods.
+     * of the {@link Formatter#setInvalidWKT(IdentifiedObject, Exception) Formatter.setInvalidWKT(…)}
+     * methods.
      *
      * <p>Alternatively, the implementation may also have no WKT keyword for this object.
      * In such case, this method shall return {@code null}.</p>

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/AbstractCRS.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/AbstractCRS.java?rev=1569913&r1=1569912&r2=1569913&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/AbstractCRS.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/AbstractCRS.java
[UTF-8] Wed Feb 19 20:46:51 2014
@@ -410,8 +410,8 @@ public class AbstractCRS extends Abstrac
      * The WKT 1 format is similar to the WKT 2 one with two differences:
      * <ul>
      *   <li>Units are formatted before the axes instead than after the axes.</li>
-     *   <li>If no unit can be formatted because not all axes use the same unit, then
the WKT
-     *       is {@linkplain Formatter#setInvalidWKT(IdentifiedObject) flagged as invalid}.</li>
+     *   <li>If no unit can be formatted because not all axes use the same unit, then
the WKT is
+     *       {@linkplain Formatter#setInvalidWKT(IdentifiedObject, Exception) flagged as
invalid}.</li>
      * </ul>
      *
      * @return {@inheritDoc}

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultEllipsoid.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultEllipsoid.java?rev=1569913&r1=1569912&r2=1569913&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultEllipsoid.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultEllipsoid.java
[UTF-8] Wed Feb 19 20:46:51 2014
@@ -72,8 +72,7 @@ import java.util.Objects;
  *
  * {@section Distance calculations}
  * This class contains an {@link #orthodromicDistance(double, double, double, double)} convenience
method
- * for calculating distances on great circles. This convenience method is provided as an
alternative to
- * the {@link org.apache.sis.referencing.GeodeticCalculator}.
+ * for calculating distances on great circles.
  *
  * {@section Creating new ellipsoid instances}
  * New instances can be created either directly by specifying all information to a factory
method (choices 3
@@ -607,8 +606,6 @@ public class DefaultEllipsoid extends Ab
      * @param  λ2 Longitude of second point (in decimal degrees).
      * @param  φ2 Latitude  of second point (in decimal degrees).
      * @return The orthodromic distance (in the units of this ellipsoid's axis).
-     *
-     * @see org.apache.sis.referencing.GeodeticCalculator
      */
     public double orthodromicDistance(double λ1, double φ1, double λ2, double φ2) {
         λ1 = toRadians(λ1);

Modified: sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/referencing/cs/HardCodedAxes.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/referencing/cs/HardCodedAxes.java?rev=1569913&r1=1569912&r2=1569913&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/referencing/cs/HardCodedAxes.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/referencing/cs/HardCodedAxes.java
[UTF-8] Wed Feb 19 20:46:51 2014
@@ -43,7 +43,6 @@ public final strictfp class HardCodedAxe
      * <p>This axis is usually part of a {@link #GEODETIC_LONGITUDE}, {@link #GEODETIC_LATITUDE},
      * {@link #ELLIPSOIDAL_HEIGHT} set.</p>
      *
-     * @see #LONGITUDE
      * @see #SPHERICAL_LONGITUDE
      * @see #GEODETIC_LATITUDE
      */
@@ -59,7 +58,6 @@ public final strictfp class HardCodedAxe
      * <p>This axis is usually part of a {@link #GEODETIC_LONGITUDE}, {@link #GEODETIC_LATITUDE},
      * {@link #ELLIPSOIDAL_HEIGHT} set.</p>
      *
-     * @see #LATITUDE
      * @see #SPHERICAL_LATITUDE
      * @see #GEODETIC_LONGITUDE
      */
@@ -80,7 +78,6 @@ public final strictfp class HardCodedAxe
      *
      * @see #GEODETIC_LONGITUDE
      * @see #SPHERICAL_LONGITUDE
-     * @see #LATITUDE
      */
     public static final DefaultCoordinateSystemAxis LONGITUDE_gon = create("Longitude", "λ",
             AxisDirection.EAST, NonSI.GRADE, -200, 200, RangeMeaning.WRAPAROUND);
@@ -93,7 +90,6 @@ public final strictfp class HardCodedAxe
      *
      * @see #GEODETIC_LATITUDE
      * @see #SPHERICAL_LATITUDE
-     * @see #LONGITUDE
      */
     public static final DefaultCoordinateSystemAxis LATITUDE_gon = create("Latitude", "φ",
             AxisDirection.NORTH, NonSI.GRADE, -100, 100, RangeMeaning.EXACT);
@@ -139,7 +135,8 @@ public final strictfp class HardCodedAxe
      * Increasing ordinates values go {@linkplain AxisDirection#UP up} and units are {@linkplain
SI#METRE metres}.
      * The abbreviation is lower case "<var>h</var>".
      *
-     * <p>This axis is usually part of a {@link #LONGITUDE}, {@link #LATITUDE}, {@link
#ALTITUDE} set.</p>
+     * <p>This axis is usually part of a {@link #GEODETIC_LONGITUDE}, {@link #GEODETIC_LATITUDE},
+     * {@link #ALTITUDE} tuple.</p>
      *
      * @see #ELLIPSOIDAL_HEIGHT
      * @see #GEOCENTRIC_RADIUS
@@ -189,7 +186,6 @@ public final strictfp class HardCodedAxe
      * <p>This axis is usually part of a {@link #SPHERICAL_LONGITUDE}, {@link #SPHERICAL_LATITUDE},
      * {@link #GEOCENTRIC_RADIUS} set.</p>
      *
-     * @see #LONGITUDE
      * @see #GEODETIC_LONGITUDE
      * @see #SPHERICAL_LATITUDE
      */
@@ -206,7 +202,6 @@ public final strictfp class HardCodedAxe
      * <p>This axis is usually part of a {@link #SPHERICAL_LONGITUDE}, {@link #SPHERICAL_LATITUDE},
      * {@link #GEOCENTRIC_RADIUS} set.</p>
      *
-     * @see #LATITUDE
      * @see #GEODETIC_LATITUDE
      * @see #SPHERICAL_LONGITUDE
      */

Modified: sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/referencing/datum/DefaultGeodeticDatumTest.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/referencing/datum/DefaultGeodeticDatumTest.java?rev=1569913&r1=1569912&r2=1569913&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/referencing/datum/DefaultGeodeticDatumTest.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/referencing/datum/DefaultGeodeticDatumTest.java
[UTF-8] Wed Feb 19 20:46:51 2014
@@ -224,7 +224,7 @@ public final strictfp class DefaultGeode
      * Tests unmarshalling.
      *
      * <p>This method is part of a chain.
-     * The next method is {@link #testWKT()}.</p>
+     * The next method is {@link #testUnmarshalledWKT()}.</p>
      *
      * @return The unmarshalled datum.
      * @throws JAXBException If an error occurred during unmarshalling.

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/io/CompoundFormat.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/io/CompoundFormat.java?rev=1569913&r1=1569912&r2=1569913&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/io/CompoundFormat.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/io/CompoundFormat.java
[UTF-8] Wed Feb 19 20:46:51 2014
@@ -134,8 +134,8 @@ public abstract class CompoundFormat<T> 
      * different roles to the different locale categories. A typical (but not mandatory)
mapping is:
      *
      * <ul>
-     *   <li>{@link Locale.Category#FORMAT} specifies the locale to use for numbers,
dates and angles formatting.</li>
-     *   <li>{@link Locale.Category#DISPLAY} specifies the locale to use for {@link
org.opengis.util.CodeList} labels
+     *   <li>{@link java.util.Locale.Category#FORMAT} specifies the locale to use for
numbers, dates and angles formatting.</li>
+     *   <li>{@link java.util.Locale.Category#DISPLAY} specifies the locale to use
for {@link org.opengis.util.CodeList} labels
      *       and {@link org.opengis.util.InternationalString} contents.</li>
      * </ul>
      *

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/math/StatisticsFormat.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/math/StatisticsFormat.java?rev=1569913&r1=1569912&r2=1569913&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/math/StatisticsFormat.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/math/StatisticsFormat.java
[UTF-8] Wed Feb 19 20:46:51 2014
@@ -126,8 +126,8 @@ public class StatisticsFormat extends Ta
      * Returns the locale for the given category. This method implements the following mapping:
      *
      * <ul>
-     *   <li>{@link Locale.Category#DISPLAY} — the {@code headerLocale} given at
construction time.</li>
-     *   <li>{@link Locale.Category#FORMAT} — the {@code locale} given at construction
time,
+     *   <li>{@link java.util.Locale.Category#DISPLAY} — the {@code headerLocale}
given at construction time.</li>
+     *   <li>{@link java.util.Locale.Category#FORMAT} — the {@code locale} given
at construction time,
      *       used for all values below the header row.</li>
      * </ul>
      *



Mime
View raw message