You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sis.apache.org by de...@apache.org on 2014/02/26 22:02:25 UTC
svn commit: r1572252 [1/2] - in /sis/branches/JDK7:
core/sis-metadata/src/main/java/org/apache/sis/internal/jaxb/code/
core/sis-metadata/src/main/java/org/apache/sis/internal/jaxb/gml/
core/sis-metadata/src/main/java/org/apache/sis/io/wkt/ core/sis-met...
Author: desruisseaux
Date: Wed Feb 26 21:02:23 2014
New Revision: 1572252
URL: http://svn.apache.org/r1572252
Log:
Javadoc simplification: replace some custom {@note} tags by CSS. Advantages:
* Easier to maintain since editing the CSS produces immediate result (no need to recompile plugin and javadoc).
* More control on the title ("Note", "API note", "Implementation note", "Note for implementors", "Compatibility note", etc).
* Allows to use {@link}, {@code} and other usual javadoc tags.
* Better rendering in IDE help window.
Inconvenient:
* Slightly more verbose (but not that much).
Modified:
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/internal/jaxb/code/PT_Locale.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/internal/jaxb/gml/GMLAdapter.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/io/wkt/Formatter.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/KeywordCase.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/AbstractMetadata.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/MetadataStandard.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyAccessor.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyInformation.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/StandardImplementation.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/TreeNode.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/TreeNodeChildren.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ISOMetadata.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ImmutableIdentifier.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultObjective.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/Citations.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/DefaultCitation.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultRepresentativeFraction.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition1D.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelope2D.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.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.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/CommonCRS.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/crs/DefaultCompoundCRS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/DefaultEngineeringCRS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/DefaultGeocentricCRS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/DefaultGeographicCRS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/DefaultImageCRS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/DefaultTemporalCRS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/DefaultVerticalCRS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/AbstractCS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/AxesConvention.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/DefaultCartesianCS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/DefaultCoordinateSystemAxis.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/DefaultCylindricalCS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/DefaultEllipsoidalCS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/DefaultLinearCS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/DefaultPolarCS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/DefaultSphericalCS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/DefaultTimeCS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/DefaultUserDefinedCS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/DefaultVerticalCS.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/cs/DirectionAlongMeridian.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/DefaultEngineeringDatum.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultGeodeticDatum.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultImageDatum.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultPrimeMeridian.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultTemporalDatum.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultVerticalDatum.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Matrices.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/MismatchedMatrixSizeException.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/NoninvertibleMatrixException.java
sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/referencing/operation/matrix/MatricesTest.java
sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/internal/jaxb/Context.java
sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/LenientComparable.java
sis/branches/JDK7/src/main/javadoc/stylesheet.css
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/internal/jaxb/code/PT_Locale.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/internal/jaxb/code/PT_Locale.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/internal/jaxb/code/PT_Locale.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/internal/jaxb/code/PT_Locale.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -127,8 +127,8 @@ public final class PT_Locale extends Xml
* Invoked by JAXB {@link javax.xml.bind.Marshaller} before this object is marshalled to XML.
* This method sets the {@link #characterEncoding} to the XML encoding.
*
- * {@note This is totally redundant with the encoding declared in the XML header. Unfortunately,
- * the <code>gmd:characterEncoding</code> element is mandatory according OGC/ISO schemas.}
+ * <div class="note"><b>Note:</b> This is totally redundant with the encoding declared in the XML header.
+ * Unfortunately, the {@code <gmd:characterEncoding>} element is mandatory according OGC/ISO schemas.</div>
*/
public void beforeMarshal(final Marshaller marshaller) {
final String encoding;
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/internal/jaxb/gml/GMLAdapter.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/internal/jaxb/gml/GMLAdapter.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/internal/jaxb/gml/GMLAdapter.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/internal/jaxb/gml/GMLAdapter.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -30,8 +30,9 @@ import org.apache.sis.xml.IdentifiedObje
* Every GML object to be marshalled have an ID attribute, which is mandatory.
* If no ID is explicitely set, a default one will be created from the wrapped object.
*
- * {@note This class is somewhat temporary. It assign the ID to the <em>wrapped</em> object.
- * In a future SIS version, we should assign the ID to the object itself.}
+ * <div class="note"><b>Note:</b>
+ * This class is somewhat temporary. It assigns the ID to the <em>wrapped</em> object.
+ * In a future SIS version, we should assign the ID to the object itself.</div>
*
* @author Guilhem Legal (Geomatys)
* @author Martin Desruisseaux (Geomatys)
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=1572252&r1=1572251&r2=1572252&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 26 21:02:23 2014
@@ -68,15 +68,16 @@ public abstract class FormattableObject
* The formatter for the {@link #toWKT()} and {@link #toString()} methods. Formatters are not
* thread-safe, consequently we must make sure that only one thread uses a given instance.
*
- * {@note We do not use synchronization because the formatter will call back user's code, which
- * introduce a risk of thread lock if the user performs his own synchronization.}
- *
- * {@note We do not use <code>ThreadLocal</code> because <code>Formatter</code> is not reentrant
- * neither, so it may produce very confusing behavior when debugging a code that perform
- * WKT formatting (some debuggers seem to invoke <code>toString()</code> for their own
- * purpose in the same thread). Since <code>toString()</code> is typically invoked for
- * debugging purpose, a single formatter for any thread is presumed sufficient.}
- *
+ * <div class="note"><b>Note 1:</b>
+ * We do not use synchronization because the formatter will call back user's code, which
+ * introduce a risk of thread lock if the user performs his own synchronization.</div>
+ *
+ * <div class="note"><b>Note 2:</b>
+ * We do not use {@link ThreadLocal} because {@code Formatter} is not reentrant neither,
+ * so it may produce very confusing behavior when debugging a code that perform WKT formatting
+ * (some debuggers seem to invoke {@code toString()} for their own purpose in the same thread).
+ * Since {@code toString()} is typically invoked for debugging purpose, a single formatter for
+ * any thread is presumed sufficient.</div>
*/
private static final AtomicReference<Formatter> FORMATTER = new AtomicReference<>();
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Formatter.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Formatter.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Formatter.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Formatter.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -1188,8 +1188,9 @@ public class Formatter implements Locali
* This method returns {@code true} if the formattable object given by {@code getEnclosingElement(depth)}
* has invoked {@link #addContextualUnit(Unit)} with a non-null unit at least once.
*
- * {@note The main purpose of this method is to allow <code>AXIS[…]</code> elements to determine if they should
- * inherit the unit specified by the enclosing CRS, or if they should specify their unit explicitly.}
+ * <div class="note"><b>Note:</b>
+ * The main purpose of this method is to allow {@code AXIS[…]} elements to determine if they should
+ * inherit the unit specified by the enclosing CRS, or if they should specify their unit explicitly.</div>
*
* @param depth 1 for the immediate parent, 2 for the parent of the parent, <i>etc.</i>
* @return Whether the parent element at the given depth has invoked {@code addContextualUnit(…)} at least once.
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/KeywordCase.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/KeywordCase.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/KeywordCase.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/KeywordCase.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -32,8 +32,9 @@ package org.apache.sis.io.wkt;
* <tr><td>{@code ENGINEERINGDATUM}</td> <td>{@code EngineeringDatum}</td></td>
* </table>
*
- * {@note Well-Known Text keywords are case insensitive at parsing time. <code>KEYWORD</code> is equivalent
- * to <code>keyword</code> is equivalent to <code>KeyWord</code> and to <code>kEYwORd</code>.}
+ * <div class="note"><b>Note:</b>
+ * Well-Known Text keywords are case insensitive at parsing time. {@code KEYWORD} is equivalent to
+ * {@code keyword} is equivalent to {@code KeyWord} and to {@code kEYwORd}.</div>
*
* @author Martin Desruisseaux (Geomatys)
* @since 0.4
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/AbstractMetadata.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/AbstractMetadata.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/AbstractMetadata.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/AbstractMetadata.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -94,8 +94,9 @@ public abstract class AbstractMetadata i
* Subclasses will typically return a hard-coded constant such as
* {@link MetadataStandard#ISO_19115}.
*
- * {@note Implementation of this method shall not depend on the object state,
- * since this method may be indirectly invoked by copy constructors.}
+ * {@section Note for implementors}
+ * Implementation of this method shall not depend on the object state,
+ * since this method may be indirectly invoked by copy constructors.
*
* @return The metadata standard implemented.
*/
@@ -216,9 +217,10 @@ public abstract class AbstractMetadata i
* {@code "alternateTitle"} collection contains two elements, then there is a node with index 0
* for the first element and an other node with index 1 for the second element.</p>
*
- * {@note The <code>(IDENTIFIER, INDEX)</code> pair can be used as a primary key for uniquely identifying
- * a node in a list of children. That uniqueness is guaranteed only for the children of a given
- * node; the same keys may appear in the children of any other nodes.}</li>
+ * <div class="note"><b>Note:</b>
+ * The {@code (IDENTIFIER, INDEX)} pair can be used as a primary key for uniquely identifying a node
+ * in a list of children. That uniqueness is guaranteed only for the children of a given node;
+ * the same keys may appear in the children of any other nodes.</div></li>
*
* <li><p>{@link org.apache.sis.util.collection.TableColumn#NAME}<br>
* A human-readable name for the node, derived from the identifier and the index.
@@ -324,10 +326,10 @@ public abstract class AbstractMetadata i
* the {@link java.util.Set#hashCode()} one and ensures that the hash code value is
* insensitive to the ordering of properties.
*
- * {@note This method does not cache the value because current implementation has no notification
- * mechanism for tracking changes in children properties. If this metadata is known to be
- * immutable, then subclasses may consider caching the hash code value if performance is
- * important.}
+ * <div class="note"><b>Implementation note:</b>
+ * This method does not cache the value because current implementation has no notification mechanism
+ * for tracking changes in children properties. If this metadata is known to be immutable,
+ * then subclasses may consider caching the hash code value if performance is important.</div>
*
* @see MetadataStandard#hashCode(Object)
*/
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/MetadataStandard.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/MetadataStandard.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/MetadataStandard.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/MetadataStandard.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -403,10 +403,11 @@ public class MetadataStandard implements
* If the given type is already an interface from this standard, then it is returned
* unchanged.
*
- * {@note The word "interface" may be taken in a looser sense than the usual Java sense
- * because if the given type is defined in this standard package, then it is returned
- * unchanged. The standard package is usually made of interfaces and code lists only,
- * but this is not verified by this method.}
+ * <div class="note"><b>Note:</b>
+ * The word "interface" may be taken in a looser sense than the usual Java sense because
+ * if the given type is defined in this standard package, then it is returned unchanged.
+ * The standard package is usually made of interfaces and code lists only, but this is
+ * not verified by this method.</div>
*
* @param type The implementation class.
* @return The interface implemented by the given implementation class.
@@ -550,10 +551,10 @@ public class MetadataStandard implements
* </li>
* </ul>
*
- * {@note The rational for implementing <code>CheckedContainer</code> is to consider each
- * <code>ExtendedElementInformation</code> instance as the set of all possible values for
- * the property. If the information had a <code>contains(E)</code> method, it would return
- * <code>true</code> if the given value is valid for that property.}
+ * <div class="note"><b>Note:</b>
+ * The rational for implementing {@code CheckedContainer} is to consider each {@code ExtendedElementInformation}
+ * instance as the set of all possible values for the property. If the information had a {@code contains(E)} method,
+ * it would return {@code true} if the given value is valid for that property.</div>
*
* In addition, for each map entry the value returned by {@link ExtendedElementInformation#getDomainValue()}
* may optionally be an instance of any of the following classes:
@@ -653,9 +654,10 @@ public class MetadataStandard implements
* {@code "alternateTitle"} collection contains two elements, then there is a node with index 0
* for the first element and an other node with index 1 for the second element.</p>
*
- * {@note The <code>(IDENTIFIER, INDEX)</code> pair can be used as a primary key for uniquely identifying
- * a node in a list of children. That uniqueness is guaranteed only for the children of a given
- * node; the same keys may appear in the children of any other nodes.}</li>
+ * <div class="note"><b>Note:</b>
+ * The {@code (IDENTIFIER, INDEX)} pair can be used as a primary key for uniquely identifying a node
+ * in a list of children. That uniqueness is guaranteed only for the children of a given node;
+ * the same keys may appear in the children of any other nodes.</div></li>
*
* <li><p>{@link org.apache.sis.util.collection.TableColumn#NAME}<br>
* A human-readable name for the node, derived from the identifier and the index.
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyAccessor.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyAccessor.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyAccessor.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyAccessor.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -91,13 +91,12 @@ class PropertyAccessor {
* Getters shared between many instances of this class. Two different implementations
* may share the same getters but different setters.
*
- * {@note In the particular case of <code>Class</code> keys, <code>IdentityHashMap</code> and
- * <code>HashMap</code> have identical behavior since <code>Class</code> is final and
- * does not override the <code>equals(Object)</code> and <code>hashCode()</code> methods.
- * The <code>IdentityHashMap</code> Javadoc claims that it is faster than the regular
- * <code>HashMap</code>. But maybe the most interesting property is that it allocates
- * less objects since <code>IdentityHashMap</code> implementation doesn't need the chain
- * of objects created by <code>HashMap</code>.}
+ * <div class="note"><b>Implementation note:</b>
+ * In the particular case of {@code Class} keys, {@code IdentityHashMap} and {@code HashMap} have identical
+ * behavior since {@code Class} is final and does not override the {@code equals(Object)} and {@code hashCode()}
+ * methods. The {@code IdentityHashMap} Javadoc claims that it is faster than the regular {@code HashMap}.
+ * But maybe the most interesting property is that it allocates less objects since {@code IdentityHashMap}
+ * implementation doesn't need the chain of objects created by {@code HashMap}.</div>
*/
private static final Map<Class<?>, Method[]> SHARED_GETTERS = new IdentityHashMap<>();
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyInformation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyInformation.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyInformation.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyInformation.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -42,10 +42,10 @@ import org.apache.sis.util.logging.Loggi
* but other types are allowed), instances of {@code PropertyInformation} are obtained
* indirectly by the {@link MetadataStandard#asInformationMap(Class, KeyNamePolicy)} method.
*
- * {@note The rational for implementing <code>CheckedContainer</code> is to consider each
- * <code>ExtendedElementInformation</code> instance as the set of all possible values
- * for the property. If the information had a <code>contains(E)</code> method, it would
- * return <code>true</code> if the given value is valid for that property.}
+ * <div class="note"><b>API note:</b>
+ * The rational for implementing {@code CheckedContainer} is to consider each {@code ExtendedElementInformation}
+ * instance as the set of all possible values for the property. If the information had a {@code contains(E)} method,
+ * it would return {@code true} if the given value is valid for that property.</div>
*
* {@section Immutability and thread safety}
* This final class is immutable and thus thread-safe.
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/StandardImplementation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/StandardImplementation.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/StandardImplementation.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/StandardImplementation.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -56,13 +56,12 @@ final class StandardImplementation exten
/**
* Implementations for a given interface, computed when first needed then cached.
*
- * {@note In the particular case of <code>Class</code> keys, <code>IdentityHashMap</code> and
- * <code>HashMap</code> have identical behavior since <code>Class</code> is final and
- * does not override the <code>equals(Object)</code> and <code>hashCode()</code> methods.
- * The <code>IdentityHashMap</code> Javadoc claims that it is faster than the regular
- * <code>HashMap</code>. But maybe the most interesting property is that it allocates
- * less objects since <code>IdentityHashMap</code> implementation doesn't need the chain
- * of objects created by <code>HashMap</code>.}
+ * <div class="note"><b>Implementation note:</b>
+ * In the particular case of {@code Class} keys, {@code IdentityHashMap} and {@code HashMap} have identical
+ * behavior since {@code Class} is final and does not override the {@code equals(Object)} and {@code hashCode()}
+ * methods. The {@code IdentityHashMap} Javadoc claims that it is faster than the regular {@code HashMap}.
+ * But maybe the most interesting property is that it allocates less objects since {@code IdentityHashMap}
+ * implementation doesn't need the chain of objects created by {@code HashMap}.</div>
*/
private final transient Map<Class<?>,Class<?>> implementations; // written by reflection on deserialization.
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/TreeNode.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/TreeNode.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/TreeNode.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/TreeNode.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -50,12 +50,12 @@ import org.apache.sis.util.resources.Voc
* set the identifier and the value, in that order, before any other operation on the new child.
* See {@code newChild()} javadoc for an example.</p>
*
- * {@note This class is not serializable because the values of the <code>indexInData</code> and
- * <code>indexInList</code> fields may not be stable. The former may be invalid if the node
- * is serialized and deserialized by two different versions of Apache SIS having properties
- * in different order. The second may be invalid if the collection is not guaranteed to
- * preserve order on serialization (e.g. <code>CodeListSet</code> with user-supplied elements,
- * in which case the elements order depends on the instantiation order).}
+ * <div class="note"><b>API note:</b>
+ * This class is not serializable because the values of the {@link #indexInData} and {@link #indexInList} fields
+ * may not be stable. The former may be invalid if the node is serialized and deserialized by two different versions
+ * of Apache SIS having properties in different order. The second may be invalid if the collection is not guaranteed
+ * to preserve order on serialization (e.g. {@code CodeListSet} with user-supplied elements, in which case the elements
+ * order depends on the instantiation order).</div>
*
* @author Martin Desruisseaux (Geomatys)
* @since 0.3
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/TreeNodeChildren.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/TreeNodeChildren.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/TreeNodeChildren.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/TreeNodeChildren.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -154,9 +154,9 @@ final class TreeNodeChildren extends Abs
* {@code index} is relative to the {@link #accessor} indexing, <strong>not</strong>
* to this collection.
*
- * {@note We do not test <code>(value instanceof Collection)</code> because the value
- * could be any user's implementation. Nothing prevent users from implementing
- * the collection interface even for singleton elements if they wish.}
+ * <div class="note"><b>Implementation note:</b>
+ * We do not test {@code (value instanceof Collection)} because the value could be any user's implementation.
+ * Nothing prevent users from implementing the collection interface even for singleton elements if they wish.</div>
*
* @param index The index in the accessor (<em>not</em> the index in this collection).
* @return {@code true} if the value at the given index is a collection.
@@ -303,9 +303,10 @@ final class TreeNodeChildren extends Abs
* ahead of time by {@link #hasNext()} since we need that information in order to determine
* if the value needs to be skipped or not.
*
- * {@note Actually we don't really need to keep this value, since it is not used outside the
- * <code>hasNext()</code> method. But we keep it for allowing the <code>next()</code>
- * method to opportunistically update the <code>TreeNode.cachedValue</code> field.}
+ * <div class="note"><b>Note:</b>
+ * Actually we don't really need to keep this value, since it is not used outside the {@link #hasNext()}
+ * method. But we keep it for allowing the {@link #next()} method to opportunistically update the
+ * {@link TreeNode#cachedValue} field.</div>
*/
private Object nextValue;
@@ -328,9 +329,10 @@ final class TreeNodeChildren extends Abs
* The value of {@link TreeNodeChildren#modCount} at construction time or after
* the last change done by this iterator. Used for concurrent modification checks.
*
- * {@note Actually this iterator should be robust to most concurrent modifications.
- * But we check anyway in order to prevent concurrent modifications in user
- * code, in case a future SIS version become more sensitive to such changes.}
+ * <div class="note"><b>Note:</b>
+ * Actually this iterator should be robust to most concurrent modifications.
+ * But we check anyway in order to prevent concurrent modifications in user
+ * code, in case a future SIS version become more sensitive to such changes.</div>
*/
private int modCountCheck;
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ISOMetadata.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ISOMetadata.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ISOMetadata.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ISOMetadata.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -90,9 +90,10 @@ public class ISOMetadata extends Modifia
* Returns the metadata standard implemented by subclasses,
* which is {@linkplain MetadataStandard#ISO_19115 ISO 19115}.
*
- * {@note Subclasses shall not override this method in a way that depends on the object state,
- * since this method may be indirectly invoked by copy constructors (i.e. is may be
- * invoked before this metadata object is fully constructed).}
+ * {@section Note for implementors}
+ * Subclasses shall not override this method in a way that depends on the object state,
+ * since this method may be indirectly invoked by copy constructors (i.e. is may be
+ * invoked before this metadata object is fully constructed).
*
* @return The metadata standard, which is {@linkplain MetadataStandard#ISO_19115 ISO 19115} by default.
*/
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=1572252&r1=1572251&r2=1572252&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] Wed Feb 26 21:02:23 2014
@@ -596,8 +596,9 @@ public class ImmutableIdentifier extends
/**
* Appends the given code or version number as an integer if possible, or as a text otherwise.
*
- * {@note ISO 19162 specifies "number or text". In Apache SIS, we restrict the numbers to integers
- * because handling version numbers like "8.2" as floating point numbers can be confusing.}
+ * <div class="note"><b>Implementation note:</b>
+ * ISO 19162 specifies "number or text". In Apache SIS, we restrict the numbers to integers
+ * because handling version numbers like "8.2" as floating point numbers can be confusing.</div>
*/
private static void appendCode(final Formatter formatter, final String text) {
if (text != null) {
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultObjective.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultObjective.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultObjective.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultObjective.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -157,9 +157,9 @@ public class DefaultObjective extends IS
* ({@linkplain IdentifierSpace#ID ID}, {@linkplain IdentifierSpace#UUID UUID}, <i>etc.</i>),
* thus providing a unified view of every kind of identifiers associated to this objective.
*
- * {@note The <code><:gmd:identifier></code> element marshalled to XML will exclude
- * all the above cited identifiers, for ISO 19139 compliance. Those identifiers
- * will appear in other XML elements or attributes.}
+ * <div class="note"><b>XML note:</b>
+ * The {@code <gmd:identifier>} element marshalled to XML will exclude all the above cited identifiers,
+ * for ISO 19139 compliance. Those identifiers will appear in other XML elements or attributes.</div>
*
* @return Identify the objective.
*/
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=1572252&r1=1572251&r2=1572252&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 26 21:02:23 2014
@@ -290,8 +290,9 @@ public final class Citations extends Sta
* <li>Otherwise this method returns {@code null}.</li>
* </ul>
*
- * {@note This method searches in alternate titles as a fallback because ISO specification said
- * that those titles are often used for abbreviations.}
+ * <div class="note"><b>Note:</b>
+ * This method searches in alternate titles as a fallback because ISO specification said
+ * that those titles are often used for abbreviations.</div>
*
* This method ignores leading and trailing whitespaces of every character sequences.
* Null references, empty character sequences and sequences of whitespaces only are ignored.
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/DefaultCitation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/DefaultCitation.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/DefaultCitation.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/DefaultCitation.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -80,20 +80,20 @@ public class DefaultCitation extends ISO
/**
* The authority for International Standard Book Number.
*
- * <p><b>Implementation note:</b> This field is read by reflection in
+ * <div class="note"><b>Implementation note:</b> This field is read by reflection in
* {@link org.apache.sis.internal.jaxb.NonMarshalledAuthority#getCitation(String)}.
* If this field is renamed or moved, then {@code NonMarshalledAuthority} needs
- * to be updated.</p>
+ * to be updated.</div>
*/
static final IdentifierSpace<String> ISBN = new NonMarshalledAuthority<>("ISBN", NonMarshalledAuthority.ISBN);
/**
* The authority for International Standard Serial Number.
*
- * <p><b>Implementation note:</b> This field is read by reflection in
+ * <div class="note"><b>Implementation note:</b> This field is read by reflection in
* {@link org.apache.sis.internal.jaxb.NonMarshalledAuthority#getCitation(String)}.
* If this field is renamed or moved, then {@code NonMarshalledAuthority} needs
- * to be updated.</p>
+ * to be updated.</div>
*/
static final IdentifierSpace<String> ISSN = new NonMarshalledAuthority<>("ISSN", NonMarshalledAuthority.ISSN);
@@ -369,9 +369,9 @@ public class DefaultCitation extends ISO
* as well as the {@linkplain #getISBN() ISBN} and {@linkplain #getISSN() ISSN} codes, thus
* providing a unified view of every kind of identifiers associated to this citation.
*
- * {@note The <code><:gmd:identifier></code> element marshalled to XML will exclude
- * all the above cited identifiers, for ISO 19139 compliance. Those identifiers
- * will appear in other XML elements or attributes.}
+ * <div class="note"><b>XML note:</b>
+ * The {@code <gmd:identifier>} element marshalled to XML will exclude all the above cited identifiers,
+ * for ISO 19139 compliance. Those identifiers will appear in other XML elements or attributes.</div>
*
* @return The identifiers, or an empty collection if none.
*
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultRepresentativeFraction.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultRepresentativeFraction.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultRepresentativeFraction.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultRepresentativeFraction.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -174,6 +174,8 @@ public class DefaultRepresentativeFracti
/**
* Returns the scale as a {@code float} type.
+ *
+ * @return The scale.
*/
@Override
public float floatValue() {
@@ -183,8 +185,11 @@ public class DefaultRepresentativeFracti
/**
* Returns 1 if the {@linkplain #getDenominator() denominator} is equals to 1, or 0 otherwise.
*
- * {@note This method is defined that way because scales smaller than 1 can
- * only be casted to 0, and NaN values are also represented by 0.}
+ * <div class="note"><b>Rational:</b>
+ * This method is defined that way because scales smaller than 1 can
+ * only be casted to 0, and NaN values are also represented by 0.</div>
+ *
+ * @return 1 if the denominator is 1, or 0 otherwise.
*/
@Override
public long longValue() {
@@ -194,8 +199,11 @@ public class DefaultRepresentativeFracti
/**
* Returns 1 if the {@linkplain #getDenominator() denominator} is equals to 1, or 0 otherwise.
*
- * {@note This method is defined that way because scales smaller than 1 can
- * only be casted to 0, and NaN values are also represented by 0.}
+ * <div class="note"><b>Rational:</b>
+ * This method is defined that way because scales smaller than 1 can
+ * only be casted to 0, and NaN values are also represented by 0.</div>
+ *
+ * @return 1 if the denominator is 1, or 0 otherwise.
*/
@Override
public int intValue() {
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -257,13 +257,13 @@ public abstract class AbstractEnvelope i
* supports also {@linkplain DirectPosition#setOrdinate(int, double) write operations},
* so changes in the position are reflected back in the envelope.
*
- * {@note The <cite>Web Coverage Service</cite> (WCS) 1.1 specification uses an extended
- * interpretation of the bounding box definition. In a WCS 1.1 data structure, the lower
- * corner defines the edges region in the directions of <em>decreasing</em> coordinate
- * values in the envelope CRS. This is usually the algebraic minimum coordinates, but not
- * always. For example, an envelope crossing the anti-meridian could have a lower corner
- * longitude greater than the upper corner longitude. Such extended interpretation applies
- * mostly to axes having <code>WRAPAROUND</code> range meaning.}
+ * <div class="note"><b>Note:</b>
+ * The <cite>Web Coverage Service</cite> (WCS) 1.1 specification uses an extended interpretation of the
+ * bounding box definition. In a WCS 1.1 data structure, the lower corner defines the edges region in the
+ * directions of <em>decreasing</em> coordinate values in the envelope CRS. This is usually the algebraic
+ * minimum coordinates, but not always. For example, an envelope crossing the anti-meridian could have a
+ * lower corner longitude greater than the upper corner longitude. Such extended interpretation applies
+ * mostly to axes having {@code WRAPAROUND} range meaning.</div>
*
* @return A view over the lower corner, typically (but not necessarily) containing minimal ordinate values.
*/
@@ -282,13 +282,13 @@ public abstract class AbstractEnvelope i
* supports also {@linkplain DirectPosition#setOrdinate(int, double) write operations},
* so changes in the position are reflected back in the envelope.
*
- * {@note The <cite>Web Coverage Service</cite> (WCS) 1.1 specification uses an extended
- * interpretation of the bounding box definition. In a WCS 1.1 data structure, the upper
- * corner defines the edges region in the directions of <em>increasing</em> coordinate
- * values in the envelope CRS. This is usually the algebraic maximum coordinates, but not
- * always. For example, an envelope crossing the anti-meridian could have an upper corner
- * longitude less than the lower corner longitude. Such extended interpretation applies
- * mostly to axes having <code>WRAPAROUND</code> range meaning.}
+ * <div class="note"><b>Note:</b>
+ * The <cite>Web Coverage Service</cite> (WCS) 1.1 specification uses an extended interpretation of the
+ * bounding box definition. In a WCS 1.1 data structure, the upper corner defines the edges region in the
+ * directions of <em>increasing</em> coordinate values in the envelope CRS. This is usually the algebraic
+ * maximum coordinates, but not always. For example, an envelope crossing the anti-meridian could have an
+ * upper corner longitude less than the lower corner longitude. Such extended interpretation applies
+ * mostly to axes having {@code WRAPAROUND} range meaning.</div>
*
* @return A view over the upper corner, typically (but not necessarily) containing maximal ordinate values.
*/
@@ -615,9 +615,10 @@ public abstract class AbstractEnvelope i
* {@linkplain #getDimension() dimension}, or if the {@linkplain #getSpan(int) span} of
* at least one axis is negative, 0 or {@link Double#NaN NaN}.
*
- * {@note Strictly speaking, there is an ambiguity if a span is <code>NaN</code> or if the envelope
- * contains both 0 and infinite spans (since 0⋅∞ = <code>NaN</code>). In such cases, this method
- * arbitrarily ignores the infinite values and returns <code>true</code>.}
+ * <div class="note"><b>Note:</b>
+ * Strictly speaking, there is an ambiguity if a span is {@code NaN} or if the envelope contains
+ * both 0 and infinite spans (since 0⋅∞ = {@code NaN}). In such cases, this method arbitrarily
+ * ignores the infinite values and returns {@code true}.</div>
*
* If {@code isEmpty()} returns {@code false}, then {@link #isAllNaN()} is guaranteed to
* also return {@code false}. However the converse is not always true.
@@ -679,8 +680,9 @@ public abstract class AbstractEnvelope i
* If it least one ordinate value in the given point is {@link Double#NaN NaN},
* then this method returns {@code false}.
*
- * {@note This method assumes that the specified point uses the same CRS than this envelope.
- * For performance raisons, it will no be verified unless Java assertions are enabled.}
+ * {@section Pre-conditions}
+ * This method assumes that the specified point uses the same CRS than this envelope.
+ * For performance reasons, it will no be verified unless Java assertions are enabled.
*
* {@section Spanning the anti-meridian of a Geographic CRS}
* For any dimension, if <var>upper</var> < <var>lower</var> then this method uses an
@@ -730,8 +732,9 @@ public abstract class AbstractEnvelope i
* envelope, then this method returns {@code true} only if {@code edgesInclusive}
* is {@code true}.
*
- * {@note This method assumes that the specified envelope uses the same CRS than this envelope.
- * For performance raisons, it will no be verified unless Java assertions are enabled.}
+ * {@section Pre-conditions}
+ * This method assumes that the specified envelope uses the same CRS than this envelope.
+ * For performance reasons, it will no be verified unless Java assertions are enabled.
*
* {@section Spanning the anti-meridian of a Geographic CRS}
* For every cases illustrated below, the yellow box is considered completely enclosed
@@ -824,8 +827,9 @@ public abstract class AbstractEnvelope i
* If one or more edges from the specified envelope coincide with an edge from this envelope,
* then this method returns {@code true} only if {@code edgesInclusive} is {@code true}.
*
- * {@note This method assumes that the specified envelope uses the same CRS than this envelope.
- * For performance raisons, it will no be verified unless Java assertions are enabled.}
+ * {@section Pre-conditions}
+ * This method assumes that the specified envelope uses the same CRS than this envelope.
+ * For performance reasons, it will no be verified unless Java assertions are enabled.
*
* {@section Spanning the anti-meridian of a Geographic CRS}
* This method can handle envelopes spanning the anti-meridian.
@@ -928,10 +932,11 @@ public abstract class AbstractEnvelope i
* given dimension <var>i</var> is {@code eps}.</li>
* </ul>
*
- * {@note Relative tolerance value (as opposed to absolute tolerance value) help to workaround
- * the fact that tolerance value are CRS dependent. For example the tolerance value need to be
+ * <div class="note"><b>Note:</b>
+ * Relative tolerance values (as opposed to absolute tolerance values) help to workaround the
+ * fact that tolerance value are CRS dependent. For example the tolerance value need to be
* smaller for geographic CRS than for UTM projections, because the former typically has a
- * [-180…180]° range while the later can have a range of thousands of meters.}
+ * [-180…180]° range while the later can have a range of thousands of meters.</div>
*
* {@section Coordinate Reference System}
* To be considered equal, the two envelopes must have the same {@linkplain #getDimension() dimension}
@@ -979,9 +984,10 @@ public abstract class AbstractEnvelope i
* Returns {@code true} if the specified object is an envelope of the same class
* with equals coordinates and {@linkplain #getCoordinateReferenceSystem() CRS}.
*
- * {@note This implementation requires that the provided <code>object</code> argument
- * is of the same class than this envelope. We do not relax this rule since not every
- * implementations in the SIS code base follow the same contract.}
+ * <div class="note"><b>Implementation note:</b>
+ * This implementation requires that the provided <code>object</code> argument is of the same class
+ * than this envelope. We do not relax this rule since not every implementations in the SIS code base
+ * follow the same contract.</div>
*
* @param object The object to compare with this envelope.
* @return {@code true} if the given object is equal to this envelope.
@@ -1045,8 +1051,9 @@ public abstract class AbstractEnvelope i
* </ul>
* }
*
- * {@note The <code>BOX</code> element is not part of the standard <cite>Well Known Text</cite>
- * (WKT) format. However it is understood by many softwares, for example GDAL and PostGIS.}
+ * <div class="note"><b>Note:</b>
+ * The {@code BOX} element is not part of the standard <cite>Well Known Text</cite> (WKT) format.
+ * However it is understood by many softwares, for example GDAL and PostGIS.</div>
*
* The string returned by this method can be {@linkplain GeneralEnvelope#GeneralEnvelope(CharSequence) parsed}
* by the {@code GeneralEnvelope} constructor.
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition1D.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition1D.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition1D.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition1D.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -147,11 +147,10 @@ public class DirectPosition1D extends Ab
}
/**
- * Returns a sequence of numbers that hold the coordinate of this position in its
- * reference system.
+ * Returns a sequence of numbers that hold the coordinate of this position in its reference system.
*
- * {@note This method is final for ensuring consistency with the <code>ordinate</code> field,
- * which is public.}
+ * <div class="note"><b>API note:</b>
+ * This method is final for ensuring consistency with the {@link #ordinate} field, which is public.</div>
*
* @return The coordinates.
*/
@@ -163,8 +162,8 @@ public class DirectPosition1D extends Ab
/**
* Returns the ordinate at the specified dimension.
*
- * {@note This method is final for ensuring consistency with the <code>ordinate</code> field,
- * which is public.}
+ * <div class="note"><b>API note:</b>
+ * This method is final for ensuring consistency with the {@link #ordinate} field, which is public.</div>
*
* @param dimension The dimension, which must be 0.
* @return The {@linkplain #ordinate}.
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -43,9 +43,10 @@ import java.util.Objects;
* This is not specific to this implementation; in Java2D too, the visual axis orientation depend
* on the {@linkplain java.awt.Graphics2D#getTransform() affine transform in the graphics context}.</p>
*
- * {@note The rational for avoiding axis orientation restriction is that other <code>DirectPosition</code>
- * implementations do not have such restriction, and it would be hard to generalize.
- * For example there is no clear "x" or "y" classification for North-East direction.}
+ * <div class="note"><b>Note:</b>
+ * The rational for avoiding axis orientation restriction is that other {@code DirectPosition} implementations
+ * do not have such restriction, and it would be hard to generalize. For example there is no clear "x" or "y"
+ * classification for North-East direction.</div>
*
* {@section Caution when used in collections}
* Do not mix instances of this class with ordinary {@link Point2D} instances
@@ -213,11 +214,10 @@ public class DirectPosition2D extends Po
}
/**
- * Returns a sequence of numbers that hold the coordinate of this position in its
- * reference system.
+ * Returns a sequence of numbers that hold the coordinate of this position in its reference system.
*
- * {@note This method is final for ensuring consistency with the <code>x</code>
- * and <code>y</code> fields, which are public.}
+ * <div class="note"><b>API note:</b>
+ * This method is final for ensuring consistency with the {@code x} and {@code y} fields, which are public.</div>
*
* @return The coordinate.
*/
@@ -229,8 +229,8 @@ public class DirectPosition2D extends Po
/**
* Returns the ordinate at the specified dimension.
*
- * {@note This method is final for ensuring consistency with the <code>x</code>
- * and <code>y</code> fields, which are public.}
+ * <div class="note"><b>API note:</b>
+ * This method is final for ensuring consistency with the {@code x} and {@code y} fields, which are public.</div>
*
* @param dimension The dimension in the range 0 to 1 inclusive.
* @return The coordinate at the specified dimension.
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelope2D.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelope2D.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelope2D.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelope2D.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -302,13 +302,13 @@ public class Envelope2D extends Rectangl
* <p>The object returned by this method is a copy. Change in the returned position
* will not affect this envelope, and conversely.</p>
*
- * {@note The <cite>Web Coverage Service</cite> (WCS) 1.1 specification uses an extended
- * interpretation of the bounding box definition. In a WCS 1.1 data structure, the lower
- * corner defines the edges region in the directions of <em>decreasing</em> coordinate
- * values in the envelope CRS. This is usually the algebraic minimum coordinates, but not
- * always. For example, an envelope spanning the anti-meridian could have a lower corner
- * longitude greater than the upper corner longitude. Such extended interpretation applies
- * mostly to axes having <code>WRAPAROUND</code> range meaning.}
+ * <div class="note"><b>Note:</b>
+ * The <cite>Web Coverage Service</cite> (WCS) 1.1 specification uses an extended interpretation of the
+ * bounding box definition. In a WCS 1.1 data structure, the lower corner defines the edges region in the
+ * directions of <em>decreasing</em> coordinate values in the envelope CRS. This is usually the algebraic
+ * minimum coordinates, but not always. For example, an envelope spanning the anti-meridian could have a
+ * lower corner longitude greater than the upper corner longitude. Such extended interpretation applies
+ * mostly to axes having {@code WRAPAROUND} range meaning.</div>
*
* @return A copy of the lower corner, typically (but not necessarily) containing minimal ordinate values.
*/
@@ -325,13 +325,13 @@ public class Envelope2D extends Rectangl
* <p>The object returned by this method is a copy. Change in the returned position
* will not affect this envelope, and conversely.</p>
*
- * {@note The <cite>Web Coverage Service</cite> (WCS) 1.1 specification uses an extended
- * interpretation of the bounding box definition. In a WCS 1.1 data structure, the upper
- * corner defines the edges region in the directions of <em>increasing</em> coordinate
- * values in the envelope CRS. This is usually the algebraic maximum coordinates, but not
- * always. For example, an envelope spanning the anti-meridian could have an upper corner
- * longitude less than the lower corner longitude. Such extended interpretation applies
- * mostly to axes having <code>WRAPAROUND</code> range meaning.}
+ * <div class="note"><b>Note:</b>
+ * The <cite>Web Coverage Service</cite> (WCS) 1.1 specification uses an extended interpretation of the
+ * bounding box definition. In a WCS 1.1 data structure, the upper corner defines the edges region in the
+ * directions of <em>increasing</em> coordinate values in the envelope CRS. This is usually the algebraic
+ * maximum coordinates, but not always. For example, an envelope spanning the anti-meridian could have an
+ * upper corner longitude less than the lower corner longitude. Such extended interpretation applies
+ * mostly to axes having {@code WRAPAROUND} range meaning.</div>
*
* @return A copy of the upper corner, typically (but not necessarily) containing maximal ordinate values.
*/
@@ -559,9 +559,9 @@ public class Envelope2D extends Rectangl
* represents this envelope as four separated rectangles.
* </ul>
*
- * {@note The return type is the <code>Rectangle2D.Double</code> implementation class rather than the
- * <code>Rectangle2D</code> abstract class because the <code>Envelope2D</code> class hierarchy
- * already exposes this implementation choice.}
+ * <div class="note"><b>API note:</b>
+ * The return type is the {@code Rectangle2D.Double} implementation class rather than the {@code Rectangle2D}
+ * abstract class because the {@code Envelope2D} class hierarchy already exposes this implementation choice.</div>
*
* @return A representation of this envelope as an array of non-empty Java2D rectangles.
* The array never contains {@code this}.
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -107,8 +107,9 @@ public final class Envelopes extends Sta
* <blockquote>{@code BOX}<var>n</var>{@code D(}{@linkplain Envelope#getLowerCorner() lower
* corner}{@code ,} {@linkplain Envelope#getUpperCorner() upper corner}{@code )}</blockquote>
*
- * {@note The <code>BOX</code> element is not part of the standard <cite>Well Known Text</cite>
- * (WKT) format. However it is understood by many softwares, for example GDAL and PostGIS.}
+ * <div class="note"><b>Note:</b>
+ * The {@code BOX} element is not part of the standard <cite>Well Known Text</cite> (WKT) format.
+ * However it is understood by many softwares, for example GDAL and PostGIS.</div>
*
* The string returned by this method can be {@linkplain GeneralEnvelope#GeneralEnvelope(CharSequence)
* parsed} by the {@code GeneralEnvelope} constructor.
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -100,10 +100,10 @@ public class GeneralDirectPosition exten
* This constructor assigns the given array directly (without clone) to the {@link #ordinates} field.
* Consequently, callers shall not recycle the same array for creating many instances.
*
- * {@note The array is not cloned because this is usually not needed, especially in the context
- * of variable argument lengths since the array is often created implicitly. Furthermore
- * the <code>ordinates</code> field is public, so cloning the array would not protect
- * the state of this object anyway.}
+ * <div class="note"><b>Implementation note:</b>
+ * The array is not cloned because this is usually not needed, especially in the context of variable
+ * argument lengths since the array is often created implicitly. Furthermore the {@link #ordinates}
+ * field is public, so cloning the array would not protect the state of this object anyway.</div>
*
* @param ordinates The ordinate values. This array is <strong>not</strong> cloned.
*/
@@ -185,11 +185,10 @@ public class GeneralDirectPosition exten
}
/**
- * Returns a sequence of numbers that hold the coordinate of this position in its
- * reference system.
+ * Returns a sequence of numbers that hold the coordinate of this position in its reference system.
*
- * {@note This method is final for ensuring consistency with the <code>ordinates</code>,
- * array field, which is public.}
+ * <div class="note"><b>API note:</b>
+ * This method is final for ensuring consistency with the {@link #ordinates}, array field, which is public.</div>
*
* @return A copy of the {@linkplain #ordinates ordinates} array.
*/
@@ -218,8 +217,8 @@ public class GeneralDirectPosition exten
/**
* Returns the ordinate at the specified dimension.
*
- * {@note This method is final for ensuring consistency with the <code>ordinates</code>,
- * array field, which is public.}
+ * <div class="note"><b>API note:</b>
+ * This method is final for ensuring consistency with the {@link #ordinates}, array field, which is public.</div>
*
* @param dimension The dimension in the range 0 to {@linkplain #getDimension() dimension}-1.
* @return The ordinate at the specified dimension.
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -46,10 +46,10 @@ import static org.apache.sis.math.MathFu
* (coordinate points). To encode an {@code Envelope}, it is sufficient to encode these
* two points.
*
- * {@note <code>Envelope</code> uses an arbitrary <cite>Coordinate Reference System</cite>, which
- * doesn't need to be geographic. This is different than the <code>GeographicBoundingBox</code>
- * class provided in the metadata package, which can be used as a kind of envelope restricted to
- * a Geographic CRS having Greenwich prime meridian.}
+ * <div class="note"><b>Note:</b>
+ * {@code Envelope} uses an arbitrary <cite>Coordinate Reference System</cite>, which does not need to be geographic.
+ * This is different than the {@code GeographicBoundingBox} class provided in the metadata package, which can be used
+ * as a kind of envelope restricted to a Geographic CRS having Greenwich prime meridian.</div>
*
* This particular implementation of {@code Envelope} is said "General" because it uses
* coordinates of an arbitrary number of dimensions. This is in contrast with
@@ -463,8 +463,9 @@ public class GeneralEnvelope extends Arr
* with the added point as an argument will return {@code true}, except if one of the point
* ordinates was {@link Double#NaN} in which case the corresponding ordinate has been ignored.</p>
*
- * {@note This method assumes that the specified point uses the same CRS than this envelope.
- * For performance raisons, it will no be verified unless Java assertions are enabled.}
+ * {@section Pre-conditions}
+ * This method assumes that the specified point uses the same CRS than this envelope.
+ * For performance reasons, it will no be verified unless Java assertions are enabled.
*
* {@section Spanning the anti-meridian of a Geographic CRS}
* This method supports envelopes spanning the anti-meridian. In such cases it is possible to
@@ -542,8 +543,9 @@ public class GeneralEnvelope extends Arr
* Adds an envelope object to this envelope. The resulting envelope is the union of the
* two {@code Envelope} objects.
*
- * {@note This method assumes that the specified envelope uses the same CRS than this envelope.
- * For performance raisons, it will no be verified unless Java assertions are enabled.}
+ * {@section Pre-conditions}
+ * This method assumes that the specified envelope uses the same CRS than this envelope.
+ * For performance reasons, it will no be verified unless Java assertions are enabled.
*
* {@section Spanning the anti-meridian of a Geographic CRS}
* This method supports envelopes spanning the anti-meridian. If one or both envelopes span
@@ -668,8 +670,9 @@ public class GeneralEnvelope extends Arr
/**
* Sets this envelope to the intersection if this envelope with the specified one.
*
- * {@note This method assumes that the specified envelope uses the same CRS than this envelope.
- * For performance raisons, it will no be verified unless Java assertions are enabled.}
+ * {@section Pre-conditions}
+ * This method assumes that the specified envelope uses the same CRS than this envelope.
+ * For performance reasons, it will no be verified unless Java assertions are enabled.
*
* {@section Spanning the anti-meridian of a Geographic CRS}
* This method supports envelopes spanning the anti-meridian.
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=1572252&r1=1572251&r2=1572252&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 26 21:02:23 2014
@@ -306,9 +306,10 @@ public class DefaultParameterDescriptor<
* Returns the GeoAPI interface implemented by this class.
* The SIS implementation returns {@code ParameterDescriptor.class}.
*
- * {@note Subclasses usually do not need to override this method since GeoAPI does not define
- * <code>ParameterDescriptor</code> sub-interface. Overriding possibility is left mostly
- * for implementors who wish to extend GeoAPI with their own set of interfaces.}
+ * <div class="note"><b>Note for implementors:</b>
+ * Subclasses usually do not need to override this method since GeoAPI does not define {@code ParameterDescriptor}
+ * sub-interface. Overriding possibility is left mostly for implementors who wish to extend GeoAPI with their own
+ * set of interfaces.</div>
*
* @return {@code ParameterDescriptor.class} or a user-defined sub-interface.
*/
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=1572252&r1=1572251&r2=1572252&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 26 21:02:23 2014
@@ -695,8 +695,9 @@ public class DefaultParameterValue<T> ex
* Parameter["False easting", 0.0, LengthUnit["metre", 1]]
* }
*
- * {@note Version 1 of WKT format did not specified the parameter unit explicitely.
- * Instead, the unit was inherited from the enclosing element.}
+ * <div class="note"><b>Compatibility note:</b>
+ * Version 1 of WKT format did not specified the parameter unit explicitely.
+ * Instead, the unit was inherited from the enclosing element.</div>
*
* @param formatter The formatter where to format the inner content of this WKT element.
* @return {@code "Parameter"}.
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=1572252&r1=1572251&r2=1572252&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 26 21:02:23 2014
@@ -753,7 +753,7 @@ public class AbstractIdentifiedObject ex
* The strictness level is controlled by the second argument,
* from stricter to more permissive values:
*
- * <p><table class="compact">
+ * <table class="compact">
* <tr><td>{@link ComparisonMode#STRICT STRICT}:</td>
* <td>Verifies if the two objects are of the same {@linkplain #getClass() class}
* and compares all public properties, including SIS-specific (non standard) properties.</td></tr>
@@ -773,7 +773,7 @@ public class AbstractIdentifiedObject ex
* <td>Same as {@code IGNORE_METADATA}, with some tolerance threshold on numerical values.</td></tr>
* <tr><td>{@link ComparisonMode#DEBUG DEBUG}:</td>
* <td>Special mode for figuring out why two objects expected to be equal are not.</td></tr>
- * </table></p>
+ * </table>
*
* The main guideline is that if {@code sourceCRS.equals(targetCRS, IGNORE_METADATA)} returns {@code true},
* then the transformation from {@code sourceCRS} to {@code targetCRS} should be the identity transform
@@ -959,7 +959,7 @@ public class AbstractIdentifiedObject ex
* For example if this formattable element is for a {@code GeodeticCRS[…]} element,
* then subclasses shall write the content starting at the insertion point shown below:
*
- * <p><table class="compact">
+ * <table class="compact">
* <tr>
* <th>WKT example</th>
* <th>Java code example</th>
@@ -975,7 +975,7 @@ public class AbstractIdentifiedObject ex
* // ... write the elements at the insertion point ...
* return "GeodeticCRS";
* }
- * </td></tr></table></p>
+ * </td></tr></table>
*
* {@section Formatting non-standard WKT}
* If the implementation can not represent this object without violating some WKT constraints,
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/CRS.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/CRS.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/CRS.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/CRS.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -395,10 +395,11 @@ public final class CRS extends Static {
* <li>Otherwise throws a {@code ClassCastException}.</li>
* </ul>
*
- * {@example Apache SIS allows 4-dimensional (<var>x</var>,<var>y</var>,<var>z</var>,<var>t</var>)
+ * <div class="note"><b>Example:</b>
+ * Apache SIS allows 4-dimensional (<var>x</var>,<var>y</var>,<var>z</var>,<var>t</var>)
* coordinate reference system to be built in two different ways as shown below:
*
- * <p><table class="compact">
+ * <table class="compact">
* <tr><th>Hierarchical structure</th><th>Flat list</th></tr>
* <tr><td><blockquote>
* <code>CompoundCRS</code> — (<var>x</var>, <var>y</var>, <var>z</var>, <var>t</var>)<br>
@@ -412,11 +413,11 @@ public final class CRS extends Static {
* <code> ├─VerticalCRS</code> — (<var>z</var>)<br>
* <code> └─TemporalCRS</code> — (<var>t</var>)
* </blockquote>
- * </td></tr></table></p>
+ * </td></tr></table>
*
* This method guaranteed that the returned list is a flat one as shown on the right side.
* Note that such flat lists are the only one allowed by ISO/OGC standards for compound CRS.
- * The hierarchical structure is an Apache SIS flexibility.}
+ * The hierarchical structure is an Apache SIS flexibility.</div>
*
* @param crs The coordinate reference system, or {@code null}.
* @return The single coordinate reference systems, or an empty list if the given CRS is {@code null}.
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/CommonCRS.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/CommonCRS.java?rev=1572252&r1=1572251&r2=1572252&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/CommonCRS.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/referencing/CommonCRS.java [UTF-8] Wed Feb 26 21:02:23 2014
@@ -158,9 +158,10 @@ public enum CommonCRS {
* <tr><th>Ellipsoid axes unit:</th> <td>{@link SI#METRE}</td></tr>
* </table></blockquote>
*
- * {@note <cite>NAD83</cite> uses the same ellipsoid for a different datum.
- * The <cite>Web Map Server</cite> <code>"CRS:83"</code> authority code uses the NAD83 datum,
- * while the <code>"IGNF:MILLER"</code> authority code uses the GRS80 datum.}
+ * <div class="note"><b>Note:</b>
+ * {@link #NAD83} uses the same ellipsoid for a different datum.
+ * The <cite>Web Map Server</cite> {@code "CRS:83"} authority code uses the NAD83 datum,
+ * while the {@code "IGNF:MILLER"} authority code uses the GRS80 datum.</div>
*/
ETRS89((short) 4258, (short) 4937, (short) 4936, (short) 6258, (short) 7019),
@@ -181,9 +182,10 @@ public enum CommonCRS {
* <tr><th>Ellipsoid axes unit:</th> <td>{@link SI#METRE}</td></tr>
* </table></blockquote>
*
- * {@note <cite>ETRS89</cite> uses the same ellipsoid for a different datum.
- * The <cite>Web Map Server</cite> <code>"CRS:83"</code> authority code uses the NAD83 datum,
- * while the <code>"IGNF:MILLER"</code> authority code uses the GRS80 datum.}
+ * <div class="note"><b>Note:</b>
+ * {@link #ETRS89} uses the same ellipsoid for a different datum.
+ * The <cite>Web Map Server</cite> {@code "CRS:83"} authority code uses the NAD83 datum,
+ * while the {@code "IGNF:MILLER"} authority code uses the GRS80 datum.</div>
*/
NAD83((short) 4269, (short) 0, (short) 0, (short) 6269, (short) 7019),
@@ -353,14 +355,15 @@ public enum CommonCRS {
* <li>Prime meridian in Greenwich.</li>
* </ul>
*
- * {@note This method makes no guarantees about the datum. The current default datum is WGS 84,
- * but this may change in future SIS versions if a WGS 84 replacement become in wide use.}
+ * <div class="note"><b>Note:</b>
+ * This method makes no guarantees about the datum. The current default datum is WGS 84,
+ * but this may change in future SIS versions if a WGS 84 replacement become in wide use.</div>
*
- * <p>This default CRS is assigned to
+ * This default CRS is assigned to
* {@linkplain org.apache.sis.geometry.GeneralEnvelope#GeneralEnvelope(org.opengis.metadata.extent.GeographicBoundingBox)
* envelopes created from a geographic bounding box}.
* Since ISO 19115 {@link org.opengis.metadata.extent.GeographicBoundingBox} is approximative by definition,
- * their datum can be arbitrary.</p>
+ * their datum can be arbitrary.
*
* @return The default two-dimensional geographic CRS with (<var>longitude</var>, <var>latitude</var>) axis order.
*/
@@ -775,9 +778,10 @@ public enum CommonCRS {
* <tr><td>Other surface</td> <td>CRS, Datum</td> <td>{@link #OTHER_SURFACE}</td></tr>
* </table></blockquote>
*
- * {@note We do not provide a <code>GEOIDAL</code> value because its definition depends on the realization epoch.
+ * <div class="note"><b>Note:</b>
+ * We do not provide a {@code GEOIDAL} value because its definition depends on the realization epoch.
* For example EGM84, EGM96 and EGM2008 are applications of three different geoid models on the WGS 84 ellipsoid.
- * The <code>MEAN_SEA_LEVEL</code> value can be used instead as an approximation of geoidal heights.}
+ * The {@link #MEAN_SEA_LEVEL} value can be used instead as an approximation of geoidal heights.</div>
*
* @author Martin Desruisseaux (Geomatys)
* @since 0.4
@@ -871,9 +875,10 @@ public enum CommonCRS {
/**
* Creates a new enumeration value of the given name.
*
- * {@note This constructor does not expect <code>VerticalDatumType</code> constant in order to avoid too
- * early class initialization. In particular, we do not want early dependency to the SIS-specific
- * <code>VerticalDatumTypes.ELLIPSOIDAL</code> constant.}
+ * <div class="note"><b>Note:</b>
+ * This constructor does not expect {@link VerticalDatumType} constant in order to avoid too
+ * early class initialization. In particular, we do not want early dependency to the SIS-specific
+ * {@code VerticalDatumTypes.ELLIPSOIDAL} constant.</div>
*/
private Vertical(final boolean isEPSG, final short crs, final short datum) {
this.isEPSG = isEPSG;
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=1572252&r1=1572251&r2=1572252&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 26 21:02:23 2014
@@ -277,10 +277,11 @@ public class AbstractCRS extends Abstrac
* Sets the coordinate system to the given value. This method is invoked only by JAXB at
* unmarshalling time and can be invoked only if the coordinate system has never been set.
*
- * {@note It was easy to put JAXB annotations directly on datum fields in subclasses because each CRS
- * type can be associated to only one datum type. But we do not have this convenience for
- * coordinate systems, where the same CRS may accept more than one kind of CS.
- * In GML, the different kinds of CS are marshalled in different XML elements.}
+ * <div class="note"><b>Implementation note:</b>
+ * It was easy to put JAXB annotations directly on datum fields in subclasses because each CRS type
+ * can be associated to only one datum type. But we do not have this convenience for coordinate systems,
+ * where the same CRS may accept more than one kind of CS. In GML, the different kinds of CS are marshalled
+ * in different XML elements.</div>
*
* @param name The property name, used only in case of error message to format.
* @throws IllegalStateException If the coordinate system has already been set.