sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1725896 - in /sis/branches/JDK8: core/sis-metadata/src/main/java/org/apache/sis/internal/metadata/sql/ core/sis-metadata/src/main/java/org/apache/sis/io/wkt/ core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/ core/sis-refe...
Date Thu, 21 Jan 2016 10:14:32 GMT
Author: desruisseaux
Date: Thu Jan 21 10:14:32 2016
New Revision: 1725896

URL: http://svn.apache.org/viewvc?rev=1725896&view=rev
Log:
Minor documentation and style fixes.

Modified:
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/internal/metadata/sql/package-info.java
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Element.java
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/Extents.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DatumShiftGrid.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/GeodeticAuthorityFactory.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/TransformSeparator.java
    sis/branches/JDK8/src/main/javadoc/stylesheet.css

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/internal/metadata/sql/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/internal/metadata/sql/package-info.java?rev=1725896&r1=1725895&r2=1725896&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/internal/metadata/sql/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/internal/metadata/sql/package-info.java
[UTF-8] Thu Jan 21 10:14:32 2016
@@ -29,7 +29,7 @@
  * The method Javadoc describes the steps for fetching that data source.
  * When used in a JavaEE container, the data source can be configured as below:
  *
- * <ol>
+ * <ol class="verbose">
  *   <li><p>Make the JDBC driver available to the web container and its applications.
On Tomcat, this
  *     is accomplished by installing the driver's JAR files into the {@code $CATALINA_HOME/lib}
directory
  *     (<a href="https://tomcat.apache.org/tomcat-9.0-doc/jndi-resources-howto.html">source</a>).</p></li>

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Element.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Element.java?rev=1725896&r1=1725895&r2=1725896&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Element.java [UTF-8]
(original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Element.java [UTF-8]
Thu Jan 21 10:14:32 2016
@@ -147,14 +147,15 @@ final class Element implements Serializa
     /**
      * Constructs a new {@code Element}.
      * The {@code sharedValues} argument have two meanings:
-     * <ul>
-     *   <li><p>If {@code null}, then the caller is parsing a WKT string. The
{@code Element}
-     *     must be mutable because its content will be emptied as the parsing progress.</p></li>
      *
-     *   <li><p>If non-null, then the caller is storing a WKT fragment. We create
the elements but the caller will
+     * <ul class="verbose">
+     *   <li>If {@code null}, then the caller is parsing a WKT string. The {@code Element}
+     *     must be mutable because its content will be emptied as the parsing progress.</li>
+     *
+     *   <li>If non-null, then the caller is storing a WKT fragment. We create the
elements but the caller will
      *     not parse them immediately. The {@code Element} should be immutable because the
fragment will potentially
      *     be reused many time. Since the fragment may be stored for a long time, the {@code
sharedValues} map will
-     *     be used for sharing unique instance of each value if possible.</p></li>
+     *     be used for sharing unique instance of each value if possible.</li>
      * </ul>
      *
      * @param text         The text to parse.

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/Extents.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/Extents.java?rev=1725896&r1=1725895&r2=1725896&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/Extents.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/Extents.java
[UTF-8] Thu Jan 21 10:14:32 2016
@@ -144,7 +144,7 @@ public final class Extents extends Stati
      * If the given {@code Extent} object contains more than one vertical extent, then this
method
      * performs a choice based on the vertical datum and the unit of measurement:
      *
-     * <ul>
+     * <ul class="verbose">
      *   <li><p><b>Choice based on vertical datum</b><br>
      *   Only the extents associated (indirectly, through their CRS) to the same non-null
{@link VerticalDatumType}
      *   will be taken in account. If all datum types are null, then this method conservatively
uses only the first

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DatumShiftGrid.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DatumShiftGrid.java?rev=1725896&r1=1725895&r2=1725896&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DatumShiftGrid.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DatumShiftGrid.java
[UTF-8] Thu Jan 21 10:14:32 2016
@@ -72,24 +72,24 @@ import java.util.Objects;
  * and apply the interpolated translations on coordinate values in their own step between
above steps 3 and 4.
  *
  * <div class="note"><b>Use cases:</b>
- * <ul>
- *   <li><p><b>Datum shift by geographic translations</b><br>
+ * <ul class="verbose">
+ *   <li><b>Datum shift by geographic translations</b><br>
  *   NADCON and NTv2 grids are defined with longitude (<var>λ</var>) and latitude
(<var>φ</var>) inputs in angular
  *   <em>degrees</em> and give (<var>Δλ</var>, <var>Δφ</var>)
translations in angular <em>seconds</em>.
  *   However SIS stores the translation values in units of grid cell rather than angular
seconds.
  *   The translations will be applied by {@link org.apache.sis.referencing.operation.transform.InterpolatedTransform}
  *   directly on the given (<var>λ</var>,<var>φ</var>) coordinates.
- *   </p></li>
+ *   </li>
  *
- *   <li><p><b>Datum shift by geocentric translations</b><br>
+ *   <li><b>Datum shift by geocentric translations</b><br>
  *   France interpolation grid is defined with longitude (<var>λ</var>) and
latitude (<var>φ</var>) inputs in angular
  *   <em>degrees</em> and gives (<var>ΔX</var>, <var>ΔY</var>,
<var>ΔZ</var>) geocentric translations in <em>metres</em>.
  *   Those translations will not be added directly to the given (<var>λ</var>,<var>φ</var>)
coordinates since there is
  *   a geographic/geocentric conversion in the middle
  *   (see {@link org.apache.sis.referencing.operation.transform.InterpolatedGeocentricTransform}).
- *   </p></li>
+ *   </li>
  *
- *   <li><p><b>Localization grid of raster data</b><br>
+ *   <li><b>Localization grid of raster data</b><br>
  *   Some remote sensing raster data are provided with a <cite>localization grid</cite>
giving pixel coordinates
  *   (e.g. latitude and longitude). This can been seen as a change from {@linkplain DefaultImageDatum
image datum}
  *   to {@linkplain DefaultGeodeticDatum geodetic datum}. The coordinate transformation process
can sometime be
@@ -97,7 +97,7 @@ import java.util.Objects;
  *   {@linkplain org.apache.sis.referencing.operation.builder.LinearTransformBuilder first
approximation},
  *   followed by small corrections for the residual part.
  *   {@code DatumShiftGrid} can describe the small corrections part.
- *   </p></li>
+ *   </li>
  * </ul></div>
  *
  * Implementations of this class shall be immutable and thread-safe.

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/GeodeticAuthorityFactory.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/GeodeticAuthorityFactory.java?rev=1725896&r1=1725895&r2=1725896&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/GeodeticAuthorityFactory.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/GeodeticAuthorityFactory.java
[UTF-8] Thu Jan 21 10:14:32 2016
@@ -75,8 +75,8 @@ public abstract class GeodeticAuthorityF
      * This method may return {@code null} if it can not obtain this information, for example
because
      * the connection to a database is not available.
      *
-     * <div class="note"><b>Example</b>
-     * A factory that create coordinate reference system objects from EPSG codes could return
+     * <div class="note"><b>Example:</b>
+     * a factory that create coordinate reference system objects from EPSG codes could return
      * a citation like below:
      *
      * {@preformat text
@@ -111,21 +111,21 @@ public abstract class GeodeticAuthorityF
      * but not always.</p>
      *
      * <div class="note"><b>Examples:</b>
-     * <ul>
-     *   <li><p>The {@link org.apache.sis.referencing.factory.sql.EPSGFactory}
authority identifier is {@code "EPSG"}
+     * <ul class="verbose">
+     *   <li>The {@link org.apache.sis.referencing.factory.sql.EPSGFactory} authority
identifier is {@code "EPSG"}
      *       and its {@code getCodeSpaces()} method returns a set containing {@code "EPSG"}.
So in this example,
      *       authority and namespace match. That namespace value means that {@code EPSGFactory.createFoo(String)}
-     *       methods accept both {@code "EPSG::4326"} (case-insensitive) and {@code "4326"}
codes as argument.</p></li>
+     *       methods accept both {@code "EPSG::4326"} (case-insensitive) and {@code "4326"}
codes as argument.</li>
      *
-     *   <li><p>The {@link org.apache.sis.referencing.factory.sql.EPSGDataAccess}
authority identifier is {@code "EPSG"}
+     *   <li>The {@link org.apache.sis.referencing.factory.sql.EPSGDataAccess} authority
identifier is {@code "EPSG"}
      *       but its {@code getCodeSpaces()} method returns an empty set. This means that
despite the EPSG authority,
      *       {@code EPSGDataAccess.createFoo(String)} methods accept only codes like {@code
"4326"} without
-     *       {@code "EPSG:"} prefix (the reason is that {@code EPSGDataAccess} is not expected
to be used directly).</p></li>
+     *       {@code "EPSG:"} prefix (the reason is that {@code EPSGDataAccess} is not expected
to be used directly).</li>
      *
-     *   <li><p>The {@link CommonAuthorityFactory} authority identifier is {@code
"OGC"} but its {@code getCodeSpaces()}
+     *   <li>The {@link CommonAuthorityFactory} authority identifier is {@code "OGC"}
but its {@code getCodeSpaces()}
      *       method returns a set containing {@code "CRS"}, {@code "AUTO"} and {@code "AUTO2"}.
      *       While OGC is the authority defining those namespaces, the {@code "OGC"} string
itself
-     *       is not used as a namespace for CRS objects (in theory — in practice some do).</p></li>
+     *       is not used as a namespace for CRS objects (in theory — in practice some do).</li>
      * </ul></div>
      *
      * The default implementation infers the namespace from the {@linkplain #getAuthority()
authority}.

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/TransformSeparator.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/TransformSeparator.java?rev=1725896&r1=1725895&r2=1725896&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/TransformSeparator.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/TransformSeparator.java
[UTF-8] Thu Jan 21 10:14:32 2016
@@ -272,16 +272,16 @@ public class TransformSeparator {
      * Returns the input dimensions to keep or kept in the separated transform.
      * This method performs the first applicable action in the following list:
      *
-     * <ol>
-     *   <li><p>Source dimensions have been explicitly set by at least one call
to {@link #addSourceDimensions(int...)}
+     * <ol class="verbose">
+     *   <li>Source dimensions have been explicitly set by at least one call to {@link
#addSourceDimensions(int...)}
      *       or {@link #addSourceDimensionRange(int, int)} since construction or since last
call to {@link #clear()}.
-     *       In such case, this method returns all specified source dimensions.</p></li>
+     *       In such case, this method returns all specified source dimensions.</li>
      *
-     *   <li><p>No source dimensions were set but {@link #separate()} has been
invoked.
+     *   <li>No source dimensions were set but {@link #separate()} has been invoked.
      *       In such case, this method returns the sequence of source dimensions that {@code
separate()} chooses to retain.
-     *       It is often, but not necessarily, all source dimensions of the transform given
at construction time.</p></li>
+     *       It is often, but not necessarily, all source dimensions of the transform given
at construction time.</li>
      *
-     *   <li><p>Otherwise an exception is thrown.</p></li>
+     *   <li>Otherwise an exception is thrown.</li>
      * </ol>
      *
      * @return The input dimension as a sequence of strictly increasing values.
@@ -333,16 +333,16 @@ public class TransformSeparator {
      * Returns the output dimensions to keep or kept in the separated transform.
      * This method performs the first applicable action in the following list:
      *
-     * <ol>
-     *   <li><p>Target dimensions have been explicitly set by at least one call
to {@link #addTargetDimensions(int...)}
+     * <ol class="verbose">
+     *   <li>Target dimensions have been explicitly set by at least one call to {@link
#addTargetDimensions(int...)}
      *       or {@link #addTargetDimensionRange(int, int)} since construction or since last
call to {@link #clear()}.
-     *       In such case, this method returns all specified target dimensions.</p></li>
+     *       In such case, this method returns all specified target dimensions.</li>
      *
-     *   <li><p>No target dimensions were set but {@link #separate()} has been
invoked.
+     *   <li>No target dimensions were set but {@link #separate()} has been invoked.
      *       In such case, the target dimensions are inferred automatically from the {@linkplain
#getSourceDimensions()
-     *       source dimensions} and the transform.</p></li>
+     *       source dimensions} and the transform.</li>
      *
-     *   <li><p>Otherwise an exception is thrown.</p></li>
+     *   <li>Otherwise an exception is thrown.</li>
      * </ol>
      *
      * @return The output dimension as a sequence of strictly increasing values.
@@ -362,14 +362,14 @@ public class TransformSeparator {
      * source dimensions} and return only the {@linkplain #addTargetDimensions(int...) specified
target dimensions}.
      * If the source or target dimensions were not specified, then they will be inferred
as below:
      *
-     * <ul>
-     *   <li><p>If source dimensions were unspecified, then the returned transform
will keep at least all source
+     * <ul class="verbose">
+     *   <li>If source dimensions were unspecified, then the returned transform will
keep at least all source
      *       dimensions needed for computing the specified target dimensions. In many cases
the returned transform
      *       unconditionally keep all source dimensions, but not necessarily. If all source
dimensions need to be
-     *       kept, it is better to {@linkplain #addSourceDimensionRange(int, int) specify
that explicitely}.</p></li>
+     *       kept, it is better to {@linkplain #addSourceDimensionRange(int, int) specify
that explicitely}.</li>
      *
-     *   <li><p>If target dimensions were unspecified, then the returned transform
will expect only the specified
-     *       source dimensions as inputs, and the target dimensions will be inferred automatically.</p></li>
+     *   <li>If target dimensions were unspecified, then the returned transform will
expect only the specified
+     *       source dimensions as inputs, and the target dimensions will be inferred automatically.</li>
      * </ul>
      *
      * The source and target dimensions actually used can be queried by calls to {@link #getSourceDimensions()}
@@ -446,7 +446,7 @@ public class TransformSeparator {
      *
      * <p>Subclasses can override this method if they need to handle some {@code MathTransform}
implementations
      * in a special way. However all implementations of this method shall obey to the following
contract:</p>
-     * <ul>
+     * <ul class="verbose">
      *   <li>{@link #sourceDimensions} and {@link #targetDimensions} should not be
assumed accurate
      *       since they may be temporarily outdated or modified during recursive calls to
this method.</li>
      *   <li>{@link #sourceDimensions} should not be modified by this method.</li>

Modified: sis/branches/JDK8/src/main/javadoc/stylesheet.css
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/src/main/javadoc/stylesheet.css?rev=1725896&r1=1725895&r2=1725896&view=diff
==============================================================================
--- sis/branches/JDK8/src/main/javadoc/stylesheet.css (original)
+++ sis/branches/JDK8/src/main/javadoc/stylesheet.css Thu Jan 21 10:14:32 2016
@@ -180,7 +180,7 @@ div.block ol {
 div.block ul > li,
 div.block ol > li {
   margin-top:    0;
-  margin-bottom: 3px;
+  margin-bottom: 0;
 }
 
 div.block ul.verbose > li,



Mime
View raw message