sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1531737 - in /sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing: StandardObjects.java datum/BursaWolfParameters.java datum/DefaultEllipsoid.java datum/DefaultPrimeMeridian.java
Date Sun, 13 Oct 2013 19:51:16 GMT
Author: desruisseaux
Date: Sun Oct 13 19:51:16 2013
New Revision: 1531737

URL: http://svn.apache.org/r1531737
Log:
Minor documentation tuning.

Modified:
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/StandardObjects.java
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/BursaWolfParameters.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/DefaultPrimeMeridian.java

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/StandardObjects.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/StandardObjects.java?rev=1531737&r1=1531736&r2=1531737&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/StandardObjects.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/StandardObjects.java
[UTF-8] Sun Oct 13 19:51:16 2013
@@ -393,7 +393,7 @@ public abstract class StandardObjects im
          * The following table summarizes the ellipsoids known to this class,
          * together with a constant that can be used for fetching that ellipsoid:
          *
-         * <blockquote><table class="compact">
+         * <blockquote><table class="sis">
          *   <tr><th>Name or alias</th>                    <th>Constant</th>
       <th>EPSG</th></tr>
          *   <tr><td>Clarke 1866</td>                      <td>{@link
#NAD27}</td>  <td>7008</td></tr>
          *   <tr><td>International 1924</td>               <td>{@link
#ED50}</td>   <td>7022</td></tr>

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/BursaWolfParameters.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/BursaWolfParameters.java?rev=1531737&r1=1531736&r2=1531737&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/BursaWolfParameters.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/BursaWolfParameters.java
[UTF-8] Sun Oct 13 19:51:16 2013
@@ -67,7 +67,7 @@ import java.util.Objects;
  * <center>from (<var>X</var><sub>s</sub>, <var>Y</var><sub>s</sub>,
<var>Z</var><sub>s</sub>)
  *           to (<var>X</var><sub>t</sub>, <var>Y</var><sub>t</sub>,
<var>Z</var><sub>t</sub>)</center>
  *
- * <p><math alttext="MathML capable browser required">
+ * <p><math display="block" alttext="MathML capable browser required">
  *   <mfenced open="[" close="]">
  *     <mtable>
  *       <mtr><mtd><msub><mi>X</mi><mi>t</mi></msub></mtd></mtr>

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=1531737&r1=1531736&r2=1531737&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] Sun Oct 13 19:51:16 2013
@@ -75,15 +75,14 @@ import java.util.Objects;
  * the {@link org.apache.sis.referencing.GeodeticCalculator}.
  *
  * {@section Creating new ellipsoid instances}
- * New instances can be created either directly by specifying all information to a factory
method, or
- * indirectly by specifying the identifier (primary key) of a database entry containing all
needed information.
- * In particular, the <a href="http://www.epsg.org">EPSG</a> database provides
definitions for many ellipsoids
- * currently or historically used by various countries around the world, and
- * Apache SIS provides convenience shortcuts for some frequently used EPSG definitions.
+ * New instances can be created either directly by specifying all information to a factory
method (choices 3
+ * and 4 below), or indirectly by specifying the identifier of an entry in a database (choices
1 and 2 below).
+ * In particular, the <a href="http://www.epsg.org">EPSG</a> database provides
definitions for many ellipsoids,
+ * and Apache SIS provides convenience shortcuts for some of them.
  *
- * <p>The first item in the following list is the easiest but most restrictive way
to get an ellipsoid.
- * Any other item can be chosen for more freedom. Each item typically implies all subsequent
items under
- * the hood, so this list can been seen as <cite>top to bottom</cite> API.</p>
+ * <p>Choice 1 in the following list is the easiest but most restrictive way to get
an ellipsoid.
+ * The other choices provide more freedom. Each choice delegates its work to the subsequent
items
+ * (in the default configuration), so this list can been seen as <cite>top to bottom</cite>
API.</p>
  *
  * <ol>
  *   <li>Create an {@code Ellipsoid} from one of the static convenience shortcuts listed
in
@@ -98,6 +97,12 @@ import java.util.Objects;
  *       static methods defined in this class.</li>
  * </ol>
  *
+ * <b>Example:</b> the following code gets the WGS84 ellipsoid:
+ *
+ * {@preformat java
+ *     Ellipsoid e = StandardObjects.Geodetic.WGS84.ellipsoid();
+ * }
+ *
  * @author  Martin Desruisseaux (IRD, Geomatys)
  * @author  Cédric Briançon (Geomatys)
  * @since   0.4 (derived from geotk-1.2)

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultPrimeMeridian.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultPrimeMeridian.java?rev=1531737&r1=1531736&r2=1531737&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultPrimeMeridian.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultPrimeMeridian.java
[UTF-8] Sun Oct 13 19:51:16 2013
@@ -43,15 +43,14 @@ import java.util.Objects;
  * Defines the origin from which longitude values are determined.
  *
  * {@section Creating new prime meridian instances}
- * New instances can be created either directly by specifying all information to a constructor,
or
- * indirectly by specifying the identifier (primary key) of a database entry containing all
needed information.
- * In particular, the <a href="http://www.epsg.org">EPSG</a> database provides
definitions for many prime meridians
- * currently or historically used by various countries around the world, and
- * Apache SIS provides convenience shortcuts for some frequently used EPSG definitions.
+ * New instances can be created either directly by specifying all information to a factory
method (choices 3
+ * and 4 below), or indirectly by specifying the identifier of an entry in a database (choices
1 and 2 below).
+ * In particular, the <a href="http://www.epsg.org">EPSG</a> database provides
definitions for many prime meridians,
+ * and Apache SIS provides convenience shortcuts for some of them.
  *
- * <p>The first item in the following list is the easiest but most restrictive way
to get a prime meridian.
- * Any other item can be chosen for more freedom. Each item typically implies all subsequent
items under
- * the hood, so this list can been seen as <cite>top to bottom</cite> API.</p>
+ * <p>Choice 1 in the following list is the easiest but most restrictive way to get
a prime meridian.
+ * The other choices provide more freedom. Each choice delegates its work to the subsequent
items
+ * (in the default configuration), so this list can been seen as <cite>top to bottom</cite>
API.</p>
  *
  * <ol>
  *   <li>Create a {@code PrimeMeridian} from one of the static convenience shortcuts
listed in
@@ -64,6 +63,12 @@ import java.util.Objects;
  *       {@linkplain #DefaultPrimeMeridian(Map, double, Unit) constructor}.</li>
  * </ol>
  *
+ * <b>Example:</b> the following code gets the Greenwich prime meridian:
+ *
+ * {@preformat java
+ *     PrimeMeridian pm = StandardObjects.Geodetic.WGS84.primeMeridian();
+ * }
+ *
  * @author  Martin Desruisseaux (IRD, Geomatys)
  * @author  Cédric Briançon (Geomatys)
  * @since   0.4 (derived from geotk-1.2)



Mime
View raw message