sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1530964 - in /sis/branches/JDK7: core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/ core/sis-utility/src/main/java/org/apache/sis/util/logging/ src/main/javadoc...
Date Thu, 10 Oct 2013 13:10:48 GMT
Author: desruisseaux
Date: Thu Oct 10 13:10:47 2013
New Revision: 1530964

URL: http://svn.apache.org/r1530964
Log:
Minor documentation fixes.

Modified:
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ImmutableIdentifier.java
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/AbstractDatum.java
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultEllipsoid.java
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultTemporalDatum.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/MonolineFormatter.java
    sis/branches/JDK7/src/main/javadoc/stylesheet.css
    sis/branches/JDK7/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/AttributeNames.java

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ImmutableIdentifier.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ImmutableIdentifier.java?rev=1530964&r1=1530963&r2=1530964&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ImmutableIdentifier.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ImmutableIdentifier.java
[UTF-8] Thu Oct 10 13:10:47 2013
@@ -246,9 +246,9 @@ public class ImmutableIdentifier impleme
      */
     public ImmutableIdentifier(final Map<String,?> properties) throws IllegalArgumentException
{
         ensureNonNull("properties", properties);
-        code      = property(properties, CODE_KEY,      String.class);
-        version   = property(properties, VERSION_KEY,   String.class);
-        remarks   = Types.toInternationalString(properties, REMARKS_KEY);
+        code    = property(properties, CODE_KEY,    String.class);
+        version = property(properties, VERSION_KEY, String.class);
+        remarks = Types.toInternationalString(properties, REMARKS_KEY);
         /*
          * Map String authority to one of the pre-defined constants (typically EPSG or OGC).
          */

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/AbstractDatum.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/AbstractDatum.java?rev=1530964&r1=1530963&r2=1530964&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/AbstractDatum.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/AbstractDatum.java
[UTF-8] Thu Oct 10 13:10:47 2013
@@ -161,9 +161,11 @@ public class AbstractDatum extends Abstr
     }
 
     /**
-     * Same convenience method than {@link org.apache.sis.cs.AbstractCS#name(int)} except
that we get the
-     * unlocalized name (usually in English locale), because the name is part of the elements
compared by
-     * the {@link #equals(Object, ComparisonMode)} method.
+     * Same convenience method than {@link org.apache.sis.referencing.cs.AbstractCS#name(int)}
except that
+     * we get the unlocalized name (usually in English locale), because the name is part
of the elements
+     * compared by the {@link #equals(Object, ComparisonMode)} method.
+     *
+     * @see org.apache.sis.referencing.cs.AbstractCS#name(int)
      */
     static Map<String,Object> name(final int key) {
         final Map<String,Object> properties = new HashMap<>(4);

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=1530964&r1=1530963&r2=1530964&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] Thu Oct 10 13:10:47 2013
@@ -65,6 +65,18 @@ import java.util.Objects;
  *       {@linkplain #getSemiMinorAxis() semi-minor axis}.</li>
  * </ul>
  *
+ * Some numerical values derived from the above properties are:
+ *
+ * <ul>
+ *   <li>{@linkplain #getAuthalicRadius() authalic radius}</li>
+ *   <li>{@linkplain #getEccentricity() eccentricity}</li>
+ * </ul>
+ *
+ * {@section Calculations}
+ * This class contains an {@link #orthodromicDistance(double, double, double, double)} convenience
method
+ * for calculating distances on the great circle. This convenience method is provided as
an alternative to
+ * the {@link org.apache.sis.referencing.GeodeticCalculator}.
+ *
  * @author  Martin Desruisseaux (IRD, Geomatys)
  * @author  Cédric Briançon (Geomatys)
  * @since   0.4 (derived from geotk-1.2)
@@ -115,12 +127,20 @@ public class DefaultEllipsoid extends Ab
     }
 
     /**
-     * WGS 1984 ellipsoid (EPSG:7030) used in GPS systems.
-     * The semi-major and semi-minor axis length are approximatively 6378137 and 6356752
-     * {@linkplain SI#METRE metres} respectively.
+     * WGS 1984 ellipsoid used in GPS systems.
      * This is the default ellipsoid for most {@code org.apache.sis} packages.
      *
+     *  <blockquote><table class="compact" style="text-align: left;">
+     *   <tr><th>EPSG code:</th>          <td>7030</td></tr>
+     *   <tr><th>Name and aliases:</th>   <td>WGS84, WGS 1984</td></tr>
+     *   <tr><th>Semi-major axis:</th>    <td>6378137</td></tr>
+     *   <tr><th>Semi-minor axis:</th>    <td>6356752 (approximative)</td></tr>
+     *   <tr><th>Inverse flattening:</th> <td>298.257223563 (definitive)</td></tr>
+     *   <tr><th>Axis unit:</th>          <td>{@link SI#METRE}</td></tr>
+     * </table></blockquote>
+     *
      * @see DefaultGeodeticDatum#WGS84
+     * @see org.apache.sis.referencing.crs.DefaultGeographicCRS#WGS84
      */
     public static final DefaultEllipsoid WGS84 = createFlattenedSphere(
             properties("WGS84", 7030, "WGS 1984"), 6378137.0, 298.257223563, SI.METRE);
@@ -181,7 +201,7 @@ public class DefaultEllipsoid extends Ab
      * @see DefaultGeodeticDatum#SPHERE
      */
     public static final DefaultEllipsoid SPHERE =
-            createEllipsoid("SPHERE", 6371000, 6371000, SI.METRE);
+            createEllipsoid("Sphere", 6371000, 6371000, SI.METRE);
 
     /**
      * The equatorial radius. This field should be considered as final.
@@ -275,7 +295,7 @@ public class DefaultEllipsoid extends Ab
     }
 
     /**
-     * Constructs a new ellipsoid using the specified axis length.
+     * Constructs a new ellipsoid using the specified name (without authority) and axis length.
      *
      * @param name          The ellipsoid name.
      * @param semiMajorAxis The equatorial radius.
@@ -292,9 +312,9 @@ public class DefaultEllipsoid extends Ab
     }
 
     /**
-     * Constructs a new ellipsoid using the specified axis length. The properties map is
-     * given unchanged to the {@linkplain AbstractIdentifiedObject#AbstractIdentifiedObject(Map)
-     * super-class constructor}.
+     * Constructs a new ellipsoid using the specified properties and axis length.
+     * The properties map is given unchanged to the
+     * {@linkplain AbstractIdentifiedObject#AbstractIdentifiedObject(Map) super-class constructor}.
      *
      * @param properties    Set of properties. Should contains at least {@code "name"}.
      * @param semiMajorAxis The equatorial radius.
@@ -316,7 +336,7 @@ public class DefaultEllipsoid extends Ab
     }
 
     /**
-     * Constructs a new ellipsoid using the specified axis length and inverse flattening
value.
+     * Constructs a new ellipsoid using the specified name (without authority), axis length
and inverse flattening value.
      *
      * @param name              The ellipsoid name.
      * @param semiMajorAxis     The equatorial radius.
@@ -333,8 +353,8 @@ public class DefaultEllipsoid extends Ab
     }
 
     /**
-     * Constructs a new ellipsoid using the specified axis length and
-     * inverse flattening value. The properties map is given unchanged to the
+     * Constructs a new ellipsoid using the specified properties, axis length and inverse
flattening value.
+     * The properties map is given unchanged to the
      * {@linkplain AbstractIdentifiedObject#AbstractIdentifiedObject(Map) super-class constructor}.
      *
      * @param properties        Set of properties. Should contains at least {@code "name"}.
@@ -597,6 +617,8 @@ public class DefaultEllipsoid extends Ab
      * @param  x2 Longitude of second point (in decimal degrees).
      * @param  y2 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 x1, double y1, double x2, double y2) {
         x1 = toRadians(x1);

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultTemporalDatum.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultTemporalDatum.java?rev=1530964&r1=1530963&r2=1530964&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultTemporalDatum.java
(original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultTemporalDatum.java
Thu Oct 10 13:10:47 2013
@@ -90,7 +90,7 @@ public class DefaultTemporalDatum extend
             name(Vocabulary.Keys.DublinJulian), new Date(-25568 * (24*60*60*1000L) + (12*60*60*1000L)));
 
     /**
-     * Default datum for time measured since January 1st, 1970 at 00:00 UTC.
+     * Datum for time measured since January 1st, 1970 at 00:00 UTC.
      *
      * @see org.apache.sis.referencing.crs.DefaultTemporalCRS#UNIX
      * @see org.apache.sis.referencing.crs.DefaultTemporalCRS#JAVA

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/MonolineFormatter.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/MonolineFormatter.java?rev=1530964&r1=1530963&r2=1530964&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/MonolineFormatter.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/MonolineFormatter.java
[UTF-8] Thu Oct 10 13:10:47 2013
@@ -45,7 +45,7 @@ import org.apache.sis.util.Debug;
  * this formatter uses only one line per message instead of two. For example messages formatted
by
  * {@code MonolineFormatter} may look like:
  *
- * <blockquote><table style="color:#FFFFFF; background:black" class="compact">
+ * <blockquote><table style="color:white; background:black" class="compact">
  * <tr><td><code>00:01</code></td><td style="background:blue"><code>CONFIG</code></td>
  *     <td><code><b>[MyApplication]</b> Read configuration from “my-application/setup.xml”.</code></td></tr>
  * <tr><td><code>00:03</code></td><td style="background:green"><code>INFO</code></td>

Modified: sis/branches/JDK7/src/main/javadoc/stylesheet.css
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/src/main/javadoc/stylesheet.css?rev=1530964&r1=1530963&r2=1530964&view=diff
==============================================================================
--- sis/branches/JDK7/src/main/javadoc/stylesheet.css (original)
+++ sis/branches/JDK7/src/main/javadoc/stylesheet.css Thu Oct 10 13:10:47 2013
@@ -64,14 +64,16 @@
 
 /*
  * Table without vertical space between rows and a little bit of space between columns.
- * This table has no border.
+ * This table has no border. Headers are still centered and other cells left-aligned.
  */
-.contentContainer .block table.compact
+.contentContainer .block table.compact,
+.contentContainer ul.blockList ul.blockList li.blockList table.compact
 {
   width:          auto;
   border:         none;
   border-spacing: 0pt;
   padding:        0pt;
+  line-height:    1em;
 }
 
 .contentContainer .block table.compact tr td
@@ -82,20 +84,6 @@
   padding-left:   3pt;
 }
 
-.contentContainer .block table.compact tr td.onright
-{
-  padding-right: 1pt;
-  text-align:    right;
-  font-weight:   normal;
-}
-
-.contentContainer .block table.compact tr td.onleft
-{
-  padding-left: 1pt;
-  text-align:   left;
-  font-weight:  normal;
-}
-
 /*
  * Formatting if the {@section} custom javadoc tag.
  */
@@ -573,7 +561,7 @@ table.packageSummary  td.colFirst {
  * The table for the class or members summaries.
  * This is where the appareance of rows are specified.
  *
- * Note: definitions need to be cancelled "table.sis" definition.
+ * Note: need to be cancelled in the "table.sis" and "table.compact" definitions.
  */
 ul.blockList ul.blockList li.blockList table {
   margin: 0 0 12px 0px;

Modified: sis/branches/JDK7/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/AttributeNames.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/AttributeNames.java?rev=1530964&r1=1530963&r2=1530964&view=diff
==============================================================================
--- sis/branches/JDK7/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/AttributeNames.java
[UTF-8] (original)
+++ sis/branches/JDK7/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/AttributeNames.java
[UTF-8] Thu Oct 10 13:10:47 2013
@@ -54,7 +54,7 @@ import org.opengis.metadata.extent.Geogr
  * Name of attributes used in the mapping from/to NetCDF metadata to ISO 19115 metadata.
  * The attributes recognized by SIS are listed below:
  *
- * <blockquote><table class="compact"><tr valign="top" width="25%"><td>
+ * <blockquote><table class="compact"><tr valign="top"><td width="25%">
  * {@value     #ACCESS_CONSTRAINT}<br>
  * {@value     #ACKNOWLEDGMENT}<br>
  * {@value     #COMMENT}<br>



Mime
View raw message