sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1544601 - in /sis/branches/JDK7/core: sis-metadata/src/main/java/org/apache/sis/metadata/iso/ sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/ sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/ sis-metadata...
Date Fri, 22 Nov 2013 16:25:31 GMT
Author: desruisseaux
Date: Fri Nov 22 16:25:30 2013
New Revision: 1544601

URL: http://svn.apache.org/r1544601
Log:
Javadoc: try to provide more descriptive package description.

Modified:
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/package-info.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/package-info.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/constraint/package-info.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/package-info.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/package-info.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/package-info.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/package-info.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/package-info.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/package-info.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/package-info.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/package-info.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/DefaultGeorectified.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/DefaultGeoreferenceable.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/package-info.java
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/io/wkt/package-info.java
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/package-info.java
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/package-info.java
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/package-info.java

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/package-info.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -16,7 +16,7 @@
  */
 
 /**
- * {@linkplain org.apache.sis.metadata.iso.acquisition.DefaultAcquisitionInformation Acquisition}
implementation.
+ * Information about the measuring instruments, the platform carrying them, and the mission
to which the data contributes.
  * An explanation for this package is provided in the {@linkplain org.opengis.metadata.acquisition
OpenGIS® javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/package-info.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -16,7 +16,7 @@
  */
 
 /**
- * {@linkplain org.apache.sis.metadata.iso.citation.DefaultCitation Citation} implementation.
+ * Reference to the data or service (citation, responsible party, contact information).
  * An explanation for this package is provided in the {@linkplain org.opengis.metadata.citation
OpenGIS® javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/constraint/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/constraint/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/constraint/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/constraint/package-info.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -16,7 +16,7 @@
  */
 
 /**
- * {@linkplain org.apache.sis.metadata.iso.constraint.DefaultConstraints Constraints} implementation.
+ * Information about legal and security constraints placed on data.
  * An explanation for this package is provided in the {@linkplain org.opengis.metadata.constraint
OpenGIS® javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/package-info.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -16,7 +16,7 @@
  */
 
 /**
- * {@linkplain org.apache.sis.metadata.iso.content.AbstractContentInformation Content information}
implementation.
+ * Description of the dataset content.
  * An explanation for this package is provided in the {@linkplain org.opengis.metadata.content
OpenGIS® javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/package-info.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -16,7 +16,7 @@
  */
 
 /**
- * {@linkplain org.apache.sis.metadata.iso.distribution.DefaultDistribution Distribution}
implementation.
+ * Information about the options for obtaining a resource (data or service).
  * An explanation for this package is provided in the {@linkplain org.opengis.metadata.distribution
OpenGIS® javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/package-info.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -16,7 +16,7 @@
  */
 
 /**
- * {@linkplain org.apache.sis.metadata.iso.extent.DefaultExtent Extent} implementation.
+ * Information about spatial, vertical, and temporal extent.
  * An explanation for this package is provided in the {@linkplain org.opengis.metadata.extent
OpenGIS® javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/package-info.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -16,7 +16,7 @@
  */
 
 /**
- * {@linkplain org.apache.sis.metadata.iso.identification.AbstractIdentification Identification}
implementation.
+ * Information to uniquely identify the data or service.
  * An explanation for this package is provided in the {@linkplain org.opengis.metadata.identification
OpenGIS® javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/package-info.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -16,7 +16,7 @@
  */
 
 /**
- * {@linkplain org.apache.sis.metadata.iso.lineage.DefaultLineage Lineage} implementation.
+ * Information about the sources and production processes of a dataset.
  * An explanation for this package is provided in the {@linkplain org.opengis.metadata.lineage
OpenGIS® javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/package-info.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -16,7 +16,7 @@
  */
 
 /**
- * {@linkplain org.apache.sis.metadata.iso.maintenance.DefaultMaintenanceInformation Maintenance
information} implementation.
+ * Information about the frequency and scope of data updates.
  * An explanation for this package is provided in the {@linkplain org.opengis.metadata.maintenance
OpenGIS® javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/package-info.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -16,7 +16,7 @@
  */
 
 /**
- * {@linkplain org.apache.sis.metadata.iso.DefaultMetadata Metadata} implementation.
+ * Root package for ISO 19115 metadata about resources (data or services).
  * An explanation for this package is provided in the {@linkplain org.opengis.metadata OpenGIS®
javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/package-info.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -16,7 +16,7 @@
  */
 
 /**
- * {@linkplain org.apache.sis.metadata.iso.quality.DefaultDataQuality Data quality} implementation.
+ * Information about data quality, accuracy and consistency of a dataset.
  * An explanation for this package is provided in the {@linkplain org.opengis.metadata.quality
OpenGIS® javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/DefaultGeorectified.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/DefaultGeorectified.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/DefaultGeorectified.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/DefaultGeorectified.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -33,9 +33,8 @@ import org.apache.sis.xml.Namespaces;
 
 
 /**
- * Grid whose cells are regularly spaced in a geographic (i.e., lat / long) or map
- * coordinate system defined in the Spatial Referencing System (SRS) so that any cell
- * in the grid can be geolocated given its grid coordinate and the grid origin, cell spacing,
+ * Grid whose cells are regularly spaced in a geographic or projected coordinate reference
system.
+ * Any cell in the grid can be geolocated given its grid coordinate and the grid origin,
cell spacing,
  * and orientation indication of whether or not geographic.
  *
  * {@section Relationship between properties}

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/DefaultGeoreferenceable.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/DefaultGeoreferenceable.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/DefaultGeoreferenceable.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/DefaultGeoreferenceable.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -30,9 +30,9 @@ import org.apache.sis.xml.Namespaces;
 
 
 /**
- * Grid with cells irregularly spaced in any given geographic/map projection coordinate
- * system, whose individual cells can be geolocated using geolocation information
- * supplied with the data but cannot be geolocated from the grid properties alone.
+ * Grid with cells irregularly spaced in any given geographic/map projection coordinate reference
system.
+ * Individual cells can be geolocated using geolocation information supplied with the data
but cannot be
+ * geolocated from the grid properties alone.
  *
  * @author  Martin Desruisseaux (IRD, Geomatys)
  * @author  Touraïvane (IRD)

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/package-info.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -16,7 +16,7 @@
  */
 
 /**
- * {@linkplain org.apache.sis.metadata.iso.spatial.AbstractSpatialRepresentation Spatial
representation} implementation.
+ * Information about the mechanisms (grid or vector) used to represent spatial data.
  * An explanation for this package is provided in the {@linkplain org.opengis.metadata.spatial
OpenGIS® javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/io/wkt/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/io/wkt/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/io/wkt/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/io/wkt/package-info.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -16,10 +16,9 @@
  */
 
 /**
- * <a href="http://www.geoapi.org/snapshot/javadoc/org/opengis/referencing/doc-files/WKT.html"><cite>Well
- * Known Text</cite> (WKT)</a> parsing and formatting. This package provides
the internal mechanism used
- * by SIS implementation. Most users do not need to know about it, except if they want to
customize the
- * parsing process or the WKT output. For example this package allows to:
+ * <cite>Well Known Text</cite> (WKT) parsing and formatting.
+ * This package provides the internal mechanism used by SIS implementation. Most users do
not need to know about it,
+ * except if they want to customize the parsing process or the WKT output. For example this
package allows to:
  *
  * <ul>
  *   <li>{@linkplain org.apache.sis.io.wkt.WKTFormat#setConvention Format the parameters
using the names

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/package-info.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -16,11 +16,19 @@
  */
 
 /**
- * {@linkplain org.apache.sis.referencing.datum.AbstractDatum Datum} implementations. An
explanation
- * for this package is provided in the {@linkplain org.opengis.referencing.datum OpenGIS®
javadoc}.
+ * Relationship of a {@code CoordinateSystem} (an abstract mathematical entity) to the earth
or other system.
+ * An explanation for this package is provided in the {@linkplain org.opengis.referencing.datum
OpenGIS® javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *
- * <p>Some worthy methods defined in this package are:</p>
+ * <p>The root class in this package is {@link org.apache.sis.referencing.datum.AbstractDatum}.
+ * Various subclasses are defined for various kinds of relationship to the Earth or time
+ * ({@linkplain org.apache.sis.referencing.datum.DefaultGeodeticDatum geodetic},
+ *  {@linkplain org.apache.sis.referencing.datum.DefaultVerticalDatum vertical},
+ *  {@linkplain org.apache.sis.referencing.datum.DefaultTemporalDatum temporal}),
+ * or to platforms (mobile or not)
+ * ({@linkplain org.apache.sis.referencing.datum.DefaultEngineeringDatum engineering},
+ *  {@linkplain org.apache.sis.referencing.datum.DefaultImageDatum image}).
+ * Some worthy methods defined in this package are:</p>
  * <ul>
  *   <li>{@link org.apache.sis.referencing.datum.DefaultEllipsoid#orthodromicDistance(double,
double, double, double)}</li>
  *   <li>{@link org.apache.sis.referencing.datum.DefaultGeodeticDatum#getPositionVectorTransformation

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/package-info.java
(original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/package-info.java
Fri Nov 22 16:25:30 2013
@@ -16,7 +16,7 @@
  */
 
 /**
- * {@linkplain org.opengis.referencing.operation.Matrix} implementations for spatio-temporal
referencing.
+ * Matrix implementations for spatio-temporal referencing.
  * Matrices can be of arbitrary size, but the most common ones in the context of geospatial
coordinate operations
  * are not greater than 5×5 (number of spatio-temporal dimensions + 1).
  * This package differs from other matrix packages by:

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/package-info.java?rev=1544601&r1=1544600&r2=1544601&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/package-info.java
[UTF-8] Fri Nov 22 16:25:30 2013
@@ -16,13 +16,14 @@
  */
 
 /**
- * {@linkplain org.apache.sis.referencing.AbstractReferenceSystem Reference system} implementations.
+ * Base classes for reference systems used for general positioning.
  * An explanation for this package is provided in the {@linkplain org.opengis.referencing
OpenGIS® javadoc}.
  * The remaining discussion on this page is specific to the SIS implementation.
  *
- * <p>This package provides implementations for general positioning, coordinate reference
systems (CRS),
- * and coordinate transformations. Coordinates can have any number of dimensions. So this
implementation
- * can handle 2D and 3D coordinates, as well as 4D, 5D, <i>etc.</i></p>
+ * <p>The most commonly used kinds of Reference Systems in Apache SIS are the <cite>Coordinate
Reference Systems</cite>
+ * (CRS), which handle coordinates of arbitrary dimensions. The SIS implementations can handle
2D and 3D coordinates,
+ * as well as 4D, 5D, <i>etc</i>. An other less-frequently used kind of Reference
System uses labels instead, as in
+ * postal address. This package is the root for both kinds, with an emphasis on the one for
coordinates.</p>
  *
  * {@section Fetching geodetic object instances}
  * Geodetic objects can be instantiated either directly by specifying all information to
a factory method



Mime
View raw message