sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1572529 [4/4] - in /sis/branches/JDK6: ./ application/sis-console/src/site/apt/ application/sis-webapp/src/site/apt/ core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/ core/sis-build-helper/src/main/java/org/apache/sis/uti...
Date Thu, 27 Feb 2014 12:13:07 GMT
Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/Locales.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/Locales.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/Locales.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/Locales.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -94,10 +94,11 @@ public final class Locales extends Stati
      * for compactness (conversions is done by {@link #toNumber(String, int)}) and for avoiding references
      * to {@code String} instances.
      *
-     * {@note Oracle JDK8 implementation computes the 3-letters codes on-the-fly instead of holding references
-     *        to pre-existing strings. If we were holding string references here, we would prevent the garbage
-     *        collector to collect the strings for all languages and countries. This would probably be a waste
-     *        of resources.}
+     * <div class="note"><b>Implementation note:</b>
+     * Oracle JDK8 implementation computes the 3-letters codes on-the-fly instead of holding references
+     * to pre-existing strings. If we were holding string references here, we would prevent the garbage
+     * collector to collect the strings for all languages and countries. This would probably be a waste
+     * of resources.</div>
      */
     private static final short[] ISO3, ISO2;
     static {
@@ -269,10 +270,10 @@ filter: for (final Locale locale : local
      * string are parsed as documented in the {@link #parse(String)} method. In particular, this method tries to
      * convert 3-letters codes to 2-letters code on a <cite>best effort</cite> basis.
      *
-     * {@example This method is useful when language codes are appended to a base property or resource name.
-     *           For example a dictionary may define the <code>"remarks"</code> property by values associated
-     *           to the <code>"remarks_en"</code> and <code>"remarks_fr"</code> keys, for English and French
-     *           locales respectively.}
+     * <div class="note"><b>Example:</b>
+     * This method is useful when language codes are appended to a base property or resource name.
+     * For example a dictionary may define the {@code "remarks"} property by values associated to the
+     * {@code "remarks_en"} and {@code "remarks_fr"} keys, for English and French locales respectively.</div>
      *
      * @param  code The language code, which may be followed by country code.
      * @param  fromIndex Index of the first character to parse.

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/NullArgumentException.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/NullArgumentException.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/NullArgumentException.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/NullArgumentException.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -23,9 +23,10 @@ package org.apache.sis.util;
  * the error is an illegal argument rather than an unexpected usage of a null pointer
  * inside a method body.
  *
- * {@note We could argue that this exception should extend <code>IllegalArgumentException</code>.
- *        However <code>NullPointerException</code> has become a more widely adopted practice and
- *        is now the recommended one in the <cite>Effective Java</cite> book.}
+ * <div class="note"><b>API note:</b>
+ * We could argue that this exception should extend {@link IllegalArgumentException}.
+ * However {@link NullPointerException} has become a more widely adopted practice and
+ * is now the recommended one in the <cite>Effective Java</cite> book.</div>
  *
  * @author Martin Desruisseaux (Geomatys)
  * @since   0.3 (derived from geotk-3.00)

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/Numbers.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/Numbers.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/Numbers.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/Numbers.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -54,13 +54,12 @@ public final class Numbers extends Stati
     /**
      * Mapping between a primitive type and its wrapper, if any.
      *
-     * {@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<?>,Numbers> MAPPING = new IdentityHashMap<Class<?>,Numbers>(11);
     static {

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -54,11 +54,12 @@ import org.apache.sis.internal.jdk8.Func
  *       a sequence of decreasing <var>T</var> values.</li>
  * </ul>
  *
- * {@example The function properties regarding order is important when converting <code>Range</code> objects.
+ * <div class="note"><b>Example:</b>
+ * The function properties regarding order is important when converting {@link org.apache.sis.measure.Range} objects.
  * For example if the converter reverses the value ordering (e.g. reverses the sign of numerical values), then the
- * minimum and maximum values in each <code>Range</code> instance need to be interchanged. If the ordering is not
- * preserved at all (neither directly or reversed), as for example in the conversion from <code>Number</code> to
- * <code>String</code>, then we can not convert ranges at all.}
+ * minimum and maximum values in each {@code Range} instance need to be interchanged. If the ordering is not preserved
+ * at all (neither directly or reversed), as for example in the conversion from {@link Number} to {@link String}, then
+ * we can not convert ranges at all.</div>
  *
  * Below are some guidelines about the function properties that a converter can declare:
  *

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/Workaround.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/Workaround.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/Workaround.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/Workaround.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -28,9 +28,10 @@ import java.lang.annotation.RetentionPol
  * This is marker annotation for source code only, in order to keep trace of code to revisit
  * when new versions of external libraries become available.
  *
- * {@note When only a portion of a method contains a workaround and the annotation can
- *        not be applied to that specific part, than it is applied to the whole method.
- *        Developers need to refer to code comments in order to locate the specific part.}
+ * <div class="note"><b>Usage note:</b>
+ * When only a portion of a method contains a workaround and the annotation can not be applied to that specific part,
+ * then it is applied to the whole method. Developers need to refer to code comments in order to locate the specific
+ * part.</div>
  *
  * @author  Martin Desruisseaux (Geomatys)
  * @since   0.3 (derived from geotk-3.15)

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -620,9 +620,10 @@ public class Cache<K,V> extends Abstract
         /**
          * Do nothing (except checking for programming error), since we don't hold any lock.
          *
-         * {@note An alternative would have been to store the result in the map anyway.
-         *        But doing so is unsafe because we have no lock; we have no guarantee that
-         *        nothing has happened in an other thread between peek and putAndUnlock.}
+         * <div class="note"><b>Implementation note:</b>
+         * An alternative would have been to store the result in the map anyway.
+         * But doing so is unsafe because we have no lock; we have no guarantee that nothing
+         * has happened in an other thread between {@code peek} and {@code putAndUnlock}.</div>
          */
         @Override
         public void putAndUnlock(final V result) throws IllegalStateException {
@@ -732,9 +733,10 @@ public class Cache<K,V> extends Abstract
             /**
              * Do nothing (except checking for programming error), since we don't hold any lock.
              *
-             * {@note An alternative would have been to store the result in the map anyway.
-             *        But doing so is unsafe because we have no lock; we have no guarantee that
-             *        nothing has happened in an other thread between peek and putAndUnlock.}
+             * <div class="note"><b>Implementation note:</b>
+             * An alternative would have been to store the result in the map anyway.
+             * But doing so is unsafe because we have no lock; we have no guarantee that nothing
+             * has happened in an other thread between {@code peek} and {@code putAndUnlock}.</div>
              */
             @Override
             public void putAndUnlock(final V result) throws IllegalStateException {

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/CodeListSet.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/CodeListSet.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/CodeListSet.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/CodeListSet.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -90,10 +90,11 @@ public class CodeListSet<E extends CodeL
      * if none. This is very rarely needed, but we need this field in case a code list has
      * more than 64 elements.
      *
-     * {@note The standard <code>EnumSet</code> class uses different implementations depending on
-     *        whether the enumeration contains more or less than 64 elements. We can not apply the
-     *        same strategy for <code>CodeListSet</code>, because new code list elements can be created
-     *        at runtime. Consequently this implementation needs to be able to growth its capacity.}
+     * <div class="note"><b>Implementation note:</b>
+     * The standard {@link java.util.EnumSet} class uses different implementations depending on whether
+     * the enumeration contains more or less than 64 elements. We can not apply the same strategy for
+     * {@code CodeListSet}, because new code list elements can be created at runtime. Consequently this
+     * implementation needs to be able to growth its capacity.</div>
      */
     private BitSet supplementary;
 

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -99,9 +99,10 @@ public class DefaultTreeTable implements
      * implementation for storing values in a single flat array. After creation, this
      * map shall be read-only since many {@code Node} instances may share it.
      *
-     * {@note This field and the {@link #columns} field could be computed from each other.
-     *        But we serialize this field anyway because children nodes will typically hold
-     *        a reference to that map, and we want to preserve the references tree.}
+     * <div class="note"><b>Implementation note:</b>
+     * This field and the {@link #columns} field could be computed from each other.
+     * But we serialize this field anyway because children nodes will typically hold
+     * a reference to that map, and we want to preserve the references tree.</div>
      *
      * @see DefaultTreeTable.Node#columnIndices
      */
@@ -666,12 +667,12 @@ public class DefaultTreeTable implements
          * parent}. This method can be used for determining if two branches of a same tree or of two
          * different trees are identical.
          *
-         * {@note This method ignores the parent because:
+         * <div class="note"><b>Implementation note:</b> This method ignores the parent because:
          * <ul>
          *   <li>When comparing the children recursively, comparing the parents would cause infinite recursivity.</li>
-         *   <li>For consistency with the <code>clone()</code> method, which can not clone the parent.</li>
+         *   <li>For consistency with the {@link #clone()} method, which can not clone the parent.</li>
          *   <li>For making possible to compare branches instead than only whole trees.</li>
-         * </ul>}
+         * </ul></div>
          *
          * @param  other The object to compare with this node.
          * @return {@code true} if the two objects are equal, ignoring the parent node.

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/RangeSet.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/RangeSet.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/RangeSet.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/RangeSet.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -61,9 +61,10 @@ import static org.apache.sis.util.Number
  * this {@code RangeSet} class and override the {@link #add(Range)}, {@link #remove(Object)} and
  * {@link #newRange(Comparable, Comparable)} methods.
  *
- * {@note Current implementation does not yet support open intervals. The ranges shall be either
- * closed intervals, or half-open. This limitation exists because supporting open intervals implies
- * that the internal array shall support duplicated values.}
+ * <div class="note"><b>Note:</b>
+ * Current implementation does not yet support open intervals. The ranges shall be either closed intervals,
+ * or half-open. This limitation exists because supporting open intervals implies that the internal array
+ * shall support duplicated values.</div>
  *
  * {@section Extensions to <code>SortedSet</code> API}
  * This class contains some methods not found in standard {@link SortedSet} API.
@@ -228,9 +229,10 @@ public class RangeSet<E extends Comparab
      * are minimal values, and all elements at odd indices are maximal values. Elements in this
      * array must be strictly increasing without duplicated values.
      *
-     * {@note The restriction against duplicated values will need to be removed in a future
-     * version if we want to support open intervals. All binary searches in this class will
-     * need to take in account the possibility for duplicated values.}
+     * <div class="note"><b>Note:</b>
+     * The restriction against duplicated values will need to be removed in a future version
+     * if we want to support open intervals. All binary searches in this class will need to
+     * take in account the possibility for duplicated values.</div>
      */
     private Object array;
 
@@ -793,8 +795,9 @@ public class RangeSet<E extends Comparab
      *           upper.minValue, !upper.isMinIncluded));
      * }
      *
-     * {@note This method takes the minimal value of the <code>upper</code> argument
-     *        rater than the maximal value because the upper endpoint is exclusive.}
+     * <div class="note"><b>API note:</b>
+     * This method takes the minimal value of the {@code upper} argument instead
+     * than the maximal value because the upper endpoint is exclusive.</div>
      *
      * @param  lower Low endpoint (inclusive) of the sub set.
      * @param  upper High endpoint (exclusive) of the sub set.

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeNodeList.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeNodeList.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeNodeList.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeNodeList.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -52,9 +52,10 @@ import org.apache.sis.util.resources.Err
  *       to {@code TreeNodeList} (we need the slower path implemented in {@code AbstractList}).</li>
  * </ul>
  *
- * {@note Being serializable may seem contradictory with the non-cloneable requirement.
- *        But serializating {@code TreeNodeList} will also serialize the parent, thus
- *        creating new copy on deserialization. So the parents should not be mixed.}
+ * <div class="note"><b>Implementation note:</b>
+ * Being serializable may seem contradictory with the non-cloneable requirement.
+ * But serializing {@code TreeNodeList} will also serialize the parent, thus
+ * creating new copy on deserialization. So the parents should not be mixed.</div>
  *
  * @author  Martin Desruisseaux (Geomatys)
  * @since   0.3

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -225,9 +225,10 @@ public interface TreeTable {
          * The user object is for information purpose only and does not appear in the rendered tree.
          * It is typically a Java object whose content is splitted into the various table columns.
          *
-         * {@example If a <code>CityLocation</code> class is defined as a (<var>city name</var>, <var>latitude</var>,
-         * <var>longitude</var>) tuple, then a <code>TreeTable.Node</code> could be defined to have 3 columns for the
-         * above 3 tuple components, and the user object could be the original <code>CityLocation</code> instance.}
+         * <div class="note"><b>Example:</b>
+         * If a {@code CityLocation} class is defined as a (<var>city name</var>, <var>latitude</var>,
+         * <var>longitude</var>) tuple, then a {@code TreeTable.Node} could be defined to have 3 columns for the
+         * above 3 tuple components, and the user object could be the original {@code CityLocation} instance.</div>
          *
          * @return Any object stored at this node by the user, or {@code null} if none.
          * @category tree

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/iso/AbstractName.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/iso/AbstractName.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/iso/AbstractName.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/iso/AbstractName.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -188,8 +188,9 @@ public abstract class AbstractName imple
      * Returns the first element in the sequence of {@linkplain #getParsedNames() parsed names}.
      * For any {@code LocalName}, this is always {@code this}.
      *
-     * {@example If <code>this</code> name is <code>"org.opengis.util.Record"</code>
-     *           (no matter its scope, then this method returns <code>"org"</code>.}
+     * <div class="note"><b>Example:</b>
+     * If {@code this} name is {@code "org.opengis.util.Record"}
+     * (no matter its scope, then this method returns {@code "org"}.</div>
      *
      * @return The first element in the list of {@linkplain #getParsedNames() parsed names}.
      */
@@ -202,8 +203,9 @@ public abstract class AbstractName imple
      * Returns the last element in the sequence of {@linkplain #getParsedNames() parsed names}.
      * For any {@code LocalName}, this is always {@code this}.
      *
-     * {@example If <code>this</code> name is <code>"org.opengis.util.Record"</code>
-     *           (no matter its scope, then this method returns <code>"Record"</code>.}
+     * <div class="note"><b>Example:</b>
+     * If {@code this} name is {@code "org.opengis.util.Record"}
+     * (no matter its scope, then this method returns {@code "Record"}.</div>
      *
      * @return The last element in the list of {@linkplain #getParsedNames() parsed names}.
      */

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/iso/DefaultRecordType.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/iso/DefaultRecordType.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/iso/DefaultRecordType.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/iso/DefaultRecordType.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -248,8 +248,9 @@ public class DefaultRecordType implement
      *     boolean isInstance = getMembers().containsAll(attributeNames);
      * }
      *
-     * {@note We do not require that {@code record.getRecordType() == this} in order to allow record
-     *        "sub-types" to define additional fields, in a way similar to Java sub-classing.}
+     * <div class="note"><b>Implementation note:</b>
+     * We do not require that {@code record.getRecordType() == this} in order to allow record
+     * "sub-types" to define additional fields, in a way similar to Java sub-classing.</div>
      *
      * @param  record The record to test for compatibility.
      * @return {@code true} if the given record is compatible with this {@code RecordType}.

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/iso/ResourceInternationalString.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/iso/ResourceInternationalString.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/iso/ResourceInternationalString.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/iso/ResourceInternationalString.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -60,9 +60,9 @@ import static org.apache.sis.util.Argume
  * {@link #getBundle(Locale)} method. This is recommended if the running environment
  * loads modules in isolated class loaders, as OSGi does for instance.
  *
- * {@note We do not provide <code>ClassLoader</code> argument in the constructor of this class
- *        because class loaders can often be hard-coded (thus avoiding the cost of an extra field)
- *        and are usually not serializable.}
+ * <div class="note"><b>API note:</b>
+ * We do not provide {@code ClassLoader} argument in the constructor of this class because class loaders
+ * can often be hard-coded (thus avoiding the cost of an extra field) and are usually not serializable.</div>
  *
  * {@section Apache SIS resources}
  * Apache SIS has its own resources mechanism, built on top of the standard {@code ResourceBundle}

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/logging/Logging.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/logging/Logging.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/logging/Logging.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/logging/Logging.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -76,10 +76,10 @@ public final class Logging extends Stati
      * The factory found on the classpath is assigned to the {@link #factory} field. If more than one factory
      * is found, then the log messages will be sent to the logging frameworks managed by all those factories.
      *
-     * {@note A previous version was providing a <code>scanForPlugins()</code> method allowing developers to
-     *        refresh the object state when new <code>LoggerFactory</code> instances become available on the
-     *        classpath of a running JVM. However it usually doesn't work since loggers are typically stored
-     *        in static final fields.}
+     * <div class="note"><b>API note:</b>
+     * A previous version was providing a {@code scanForPlugins()} method allowing developers to refresh the
+     * object state when new {@link LoggerFactory} instances become available on the classpath of a running JVM.
+     * However it usually doesn't work since loggers are typically stored in static final fields.</div>
      *
      * @see #setLoggerFactory(LoggerFactory)
      */
@@ -410,9 +410,10 @@ public final class Logging extends Stati
      * Invoked when an unexpected error occurred while configuring the system. The error shall not
      * prevent the application from working, but may change the behavior in some minor aspects.
      *
-     * {@example if the <code>org.apache.sis.util.logging.MonolineFormatter.time</code> pattern declared
-     * in the <code>jre/lib/logging.properties</code> file is illegal, then <code>MonolineFormatter</code>
-     * while log this problem and use a default time pattern.}
+     * <div class="note"><b>Example:</b>
+     * If the {@code org.apache.sis.util.logging.MonolineFormatter.time} pattern declared in the
+     * {@code jre/lib/logging.properties} file is illegal, then {@link MonolineFormatter} will log
+     * this problem and use a default time pattern.</div>
      *
      * @param classe  The class where the error occurred.
      * @param method  The method name where the error occurred.

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/logging/MonolineFormatter.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/logging/MonolineFormatter.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/logging/MonolineFormatter.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/logging/MonolineFormatter.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -404,8 +404,9 @@ loop:   for (int i=0; ; i++) {
      * Sets the format for elapsed time, or hides the time field. The pattern must matches the
      * format specified in {@link SimpleDateFormat}, but for the time part only (no date).
      *
-     * {@example The <code>"HH:mm:ss.SSS"</code> pattern will display the elapsed time in hours,
-     * minutes, seconds and milliseconds.}
+     * <div class="note"><b>Example:</b>
+     * The {@code "HH:mm:ss.SSS"} pattern will display the elapsed time in hours, minutes, seconds
+     * and milliseconds.</div>
      *
      * @param  pattern The time pattern, or {@code null} to disable time formatting.
      * @throws IllegalArgumentException If the given pattern is invalid.
@@ -903,8 +904,9 @@ loop:   for (int i=0; ; i++) {
      *       root logger.</li>
      * </ul>
      *
-     * {@note The current implementation does not check for duplicated <code>ConsoleHandler</code> instances,
-     *        and does not check if any child logger has a <code>ConsoleHandler</code>.}
+     * <div class="note"><b>Implementation note:</b>
+     * The current implementation does not check for duplicated {@code ConsoleHandler} instances,
+     * and does not check if any child logger has a {@code ConsoleHandler}.</div>
      *
      * @return The new or existing {@code MonolineFormatter}. The formatter output can be configured
      *         using the {@link #setTimeFormat(String)} and {@link #setSourceFormat(String)} methods.
@@ -938,8 +940,9 @@ loop:   for (int i=0; ; i++) {
      *     </ul></li>
      * </ul>
      *
-     * {@note The current implementation does not check for duplicated <code>ConsoleHandler</code> instances,
-     *        and does not check if any child logger has a <code>ConsoleHandler</code>.}
+     * <div class="note"><b>Implementation note:</b>
+     * The current implementation does not check for duplicated {@code ConsoleHandler} instances,
+     * and does not check if any child logger has a {@code ConsoleHandler}.</div>
      *
      * {@section Specifying a log level}
      * This method can opportunistically set the handler level. If the given level is non-null,

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/logging/PerformanceLevel.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/logging/PerformanceLevel.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/logging/PerformanceLevel.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/logging/PerformanceLevel.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -147,9 +147,10 @@ public final class PerformanceLevel exte
      *       are also set to the given duration.</li>
      * </ul>
      *
-     * {@note The duration of the <code>PERFORMANCE</code> level can not be modified: it is
-     *        always zero. However invoking this method on the <code>PERFORMANCE</code> field will
-     *        ensure that every <code>SLOW*</code> levels will have at least the given duration.}
+     * <div class="note"><b>Usage note:</b>
+     * The duration of the {@link #PERFORMANCE} level can not be modified: it is always zero.
+     * However invoking this method on the {@code PERFORMANCE} field will ensure that every
+     * {@code SLOW*} levels will have at least the given duration.</div>
      *
      * @param  duration The minimal duration.
      * @param  unit The unit of the given duration value.

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/Errors.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/Errors.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/Errors.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/Errors.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -956,9 +956,10 @@ public final class Errors extends Indexe
      * validity. If the key is invalid, then a {@link MissingResourceException} may be thrown
      * when a {@link InternationalString#toString(Locale)} method is invoked.
      *
-     * {@note This method is redundant with the one expecting <code>Object...</code>, but avoid
-     *        the creation of a temporary array. There is no risk of confusion since the two
-     *        methods delegate their work to the same <code>format</code> method anyway.}
+     * <div class="note"><b>API note:</b>
+     * This method is redundant with the one expecting {@code Object...}, but avoid the creation
+     * of a temporary array. There is no risk of confusion since the two methods delegate their
+     * work to the same {@code format} method anyway.</div>
      *
      * @param  key The key for the desired string.
      * @param  arg Values to substitute to "{0}".

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/IndexedResourceBundle.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/IndexedResourceBundle.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/IndexedResourceBundle.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/IndexedResourceBundle.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -378,7 +378,8 @@ public class IndexedResourceBundle exten
      * Any characters sequences of length greater than {@link #MAX_STRING_LENGTH} will be shortened using
      * the {@link CharSequences#shortSentence(CharSequence, int)} method.</p>
      *
-     * {@note if more cases are added, remember to update class and package javadoc.}
+     * <div class="note"><b>Note:</b>
+     * If more cases are added, remember to update class and package javadoc.</div>
      *
      * @param  arguments The object to check.
      * @return {@code arguments} as an array, eventually with some elements replaced.

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/Messages.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/Messages.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/Messages.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/Messages.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -230,9 +230,10 @@ public final class Messages extends Inde
      * validity. If the key is invalid, then a {@link MissingResourceException} may be thrown
      * when a {@link InternationalString#toString(Locale)} method is invoked.
      *
-     * {@note This method is redundant with the one expecting <code>Object...</code>, but avoid
-     *        the creation of a temporary array. There is no risk of confusion since the two
-     *        methods delegate their work to the same <code>format</code> method anyway.}
+     * <div class="note"><b>API note:</b>
+     * This method is redundant with the one expecting {@code Object...}, but avoid the creation
+     * of a temporary array. There is no risk of confusion since the two methods delegate their
+     * work to the same {@code format} method anyway.</div>
      *
      * @param  key The key for the desired string.
      * @param  arg Values to substitute to "{0}".

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/Vocabulary.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/Vocabulary.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/Vocabulary.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/Vocabulary.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -481,9 +481,10 @@ public final class Vocabulary extends In
      * validity. If the key is invalid, then a {@link MissingResourceException} may be thrown
      * when a {@link InternationalString#toString(Locale)} method is invoked.
      *
-     * {@note This method is redundant with the one expecting <code>Object...</code>, but avoid
-     *        the creation of a temporary array. There is no risk of confusion since the two
-     *        methods delegate their work to the same <code>format</code> method anyway.}
+     * <div class="note"><b>API note:</b>
+     * This method is redundant with the one expecting {@code Object...}, but avoid the creation
+     * of a temporary array. There is no risk of confusion since the two methods delegate their
+     * work to the same {@code format} method anyway.</div>
      *
      * @param  key The key for the desired string.
      * @param  arg Values to substitute to "{0}".

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/package-info.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/package-info.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/util/resources/package-info.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -31,19 +31,17 @@
  *   <li>the value string is compliant with the {@link java.text.MessageFormat} syntax.</li>
  * </ul>
  *
- * {@note <code>java.util.Formatter</code> is an alternative to <code>MessageFormat</code> providing
- *        similar functionalities with a C/C++ like syntax. However <code>MessageFormat</code> has two
- *        advantages: it provides a <code>choice</code> format type (useful for handling plural forms),
- *        and localizes properly objects of unspecified type (by contrast, the <code>Formatter</code>
- *        <code>"%s"</code> type always invoke <code>toString()</code>). The later advantage is
- *        important for messages in wich the same argument could receive <code>Number</code> or
- *        <code>Date</code> instances as well as <code>String</code>.
- *        Furthermore, the <code>java.util.logging</code> framework is designed for use with
- *        <code>MessageFormat</code> (see the <code>Formatter.formatMessage(LogRecord)</code> method).}
- *
- * Apache SIS developers can add resources by editing the {@code *.properties} file
- * in the source code directory, then run the localized resources compiler provided in the
- * <code><a href="{@website}/sis-build-helper/index.html">sis-build-helper</a></code> module.
+ * <div class="note"><b>Note:</b>
+ * {@link java.util.Formatter java.util.Formatter} is an alternative to {@link java.text.MessageFormat} providing
+ * similar functionalities with a C/C++ like syntax. However {@code MessageFormat} has two advantages: it provides
+ * a {@code choice} format type (useful for handling plural forms), and localizes properly objects of unspecified type
+ * (by contrast, the {@code Formatter} {@code "%s"} type always invoke {@code toString()}). The later advantage is
+ * important for messages in which the same argument could receive {@link java.lang.Number} or {@link java.util.Date}
+ * instances as well as {@link java.lang.String}. Furthermore, the {@link java.util.logging} framework is designed for
+ * use with {@code MessageFormat} (see the {@code Formatter.formatMessage(LogRecord)} method).</div>
+ *
+ * Apache SIS developers can add resources by editing the {@code *.properties} file in the source code directory,
+ * then run the localized resources compiler provided in the {@code sis-build-helper} module.
  * Developers shall <strong>not</strong> apply the {@code MessageFormat} rules for using quotes,
  * since the resources compiler will apply itself the <cite>doubled single quotes</cite> when
  * necessary. This avoid the unfortunate confusion documented in the warning section of

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/MarshallerPool.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/MarshallerPool.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/MarshallerPool.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/MarshallerPool.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -101,10 +101,11 @@ public class MarshallerPool {
      * The provider of {@code AdapterReplacement} instances.
      * <strong>Every usage of this service loader must be synchronized.</strong>
      *
-     * {@note Each <code>MarshallerPool</code> has its own service loader instance rather than using a
-     *        system-wide instance because the <code>ClassLoader</code> used by the service loader is
-     *        the <cite>context class loader</cite>, which depends on the thread that created the pool.
-     *        So two pools in two different applications could have two different set of replacements.}
+     * <div class="note"><b>Implementation note:</b>
+     * Each {@code MarshallerPool} has its own service loader instance rather than using a system-wide instance
+     * because the {@link ClassLoader} used by the service loader is the <cite>context class loader</cite>,
+     * which depends on the thread that created the pool. So two pools in two different applications could have
+     * two different set of replacements.</div>
      */
     private final ServiceLoader<AdapterReplacement> replacements;
 

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/NilObjectHandler.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/NilObjectHandler.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/NilObjectHandler.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/NilObjectHandler.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -43,8 +43,9 @@ import org.apache.sis.internal.jdk7.Obje
  * definition were found for a XML element identified by {@code xlink} or {@code uuidref}
  * attributes.
  *
- * {@note The same handler could be used for every proxy having the same XLink.
- *        For now, it doesn't seem worth to cache the handlers.}
+ * <div class="note"><b>Implementation note:</b>
+ * The same handler could be used for every proxy having the same XLink.
+ * For now, it doesn't seem worth to cache the handlers.</div>
  *
  * @author  Martin Desruisseaux (Geomatys)
  * @since   0.3 (derived from geotk-3.18)

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/NilReason.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/NilReason.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/NilReason.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/NilReason.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -432,11 +432,11 @@ public final class NilReason implements 
      * <p><b>REMINDER:<b> If more special cases are added, do not forget to update the {@link #mayBeNil(Object)}
      * method and to update the {@link #createNilObject(Class)} and {@link #forObject(Object)} javadoc.</p>
      *
-     * {@note There is no special case for <code>Character</code> because Java <code>char</code>s are not really
-     *        full Unicode characters. They are parts of UTF-16 encoding instead. If there is a need to represent
-     *        a single Unicode character, we should probably still use a <code>String</code> where the string may
-     *        contain up to 2 Java characters. This may also facilitate the encoding in the XML files, since many
-     *        files use an other encoding than UTF-16 anyway.}
+     * <div class="note"><b>Implementation note:</b>
+     * There is no special case for {@link Character} because Java {@code char}s are not really full Unicode characters.
+     * They are parts of UTF-16 encoding instead. If there is a need to represent a single Unicode character, we should
+     * probably still use a {@link String} where the string contain 1 or 2 Java characters. This may also facilitate the
+     * encoding in the XML files, since many files use an other encoding than UTF-16 anyway.</div>
      *
      * @throws IllegalArgumentException If the given type is not a supported type.
      */

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/XLink.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/XLink.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/XLink.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/XLink.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -417,9 +417,9 @@ public class XLink implements Serializab
      * Returns a URN to an external resources, or to an other part of a XML document, or an
      * identifier.
      *
-     * {@note This serves a role similar to <code>idref</code>. The <code>idref</code>
-     *        attribute allows an XML element to refer to another XML element that has
-     *        a corresponding <code>id</code> attribute.}
+     * <div class="note"><b>Note:</b>
+     * This serves a role similar to {@code idref}. The {@code idref} attribute allows an XML element
+     * to refer to another XML element that has a corresponding {@code id} attribute.</div>
      *
      * @return A URN to a resources, or {@code null} if none.
      *

Modified: sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/XML.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/XML.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/XML.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/java/org/apache/sis/xml/XML.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -152,12 +152,12 @@ public final class XML extends Static {
      * Specifies the GML version of the document to be marshalled or unmarshalled.
      * The GML version may affect the set of XML elements to be marshalled and their namespaces.
      *
-     * {@note Newer versions typically have more elements, but not always.
-     * For example in <code>gml:VerticalDatum</code>, the <code>gml:verticalDatumType</code> property
-     * presents in GML 3.0 and 3.1 has been removed in GML 3.2.}
+     * <div class="note"><b>Compatibility note:</b>
+     * Newer versions typically have more elements, but not always. For example in {@code <gml:VerticalDatum>},
+     * the {@code <gml:verticalDatumType>} property presents in GML 3.0 and 3.1 has been removed in GML 3.2.</div>
      *
-     * <p>The value can be {@link String} or {@link Version} objects.
-     * If no version is specified, then the most recent GML version is assumed.</p>
+     * The value can be {@link String} or {@link Version} objects.
+     * If no version is specified, then the most recent GML version is assumed.
      *
      * {@section Supported GML versions}
      * Apache SIS currently supports GML 3.2.1 by default. SIS can read and write GML 3.2
@@ -322,10 +322,11 @@ public final class XML extends Static {
     /**
      * Returns the default (un)marshaller pool used by all methods in this class.
      *
-     * {@note Current implementation uses the double-check idiom. This is usually a deprecated
-     * practice (the recommended alterative is to use static class initialization), but in this
-     * particular case the field may be reset to <code>null</code> if OSGi modules are loaded
-     * or unloaded, so static class initialization would be a little bit too rigid.}
+     * <div class="note"><b>Implementation note:</b>
+     * Current implementation uses the double-check idiom. This is usually a deprecated practice
+     * (the recommended alterative is to use static class initialization), but in this particular
+     * case the field may be reset to {@code null} if OSGi modules are loaded or unloaded, so static
+     * class initialization would be a little bit too rigid.</div>
      */
     private static MarshallerPool getPool() throws JAXBException {
         MarshallerPool pool = POOL;

Modified: sis/branches/JDK6/core/sis-utility/src/main/javadoc/overview.html
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/main/javadoc/overview.html?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/main/javadoc/overview.html (original)
+++ sis/branches/JDK6/core/sis-utility/src/main/javadoc/overview.html Thu Feb 27 12:13:03 2014
@@ -25,7 +25,7 @@
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   </head>
   <body>
-    Overview of Apache <a href="{@website}/sis-utility">sis-utility</a> module.
+    Overview of Apache <code>sis-utility</code> module.
     This Javadoc is only about one specific module. For the full Apache SIS project,
     see the <a href="http://sis.apache.org/apidocs/overview-summary.html">aggregated Javadoc</a>.
   </body>

Modified: sis/branches/JDK6/core/sis-utility/src/test/java/org/apache/sis/test/TestRunner.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/test/java/org/apache/sis/test/TestRunner.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/test/java/org/apache/sis/test/TestRunner.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/test/java/org/apache/sis/test/TestRunner.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -70,9 +70,9 @@ public final class TestRunner extends Bl
      * The dependency methods that failed. This set will be created only when first needed.
      * Values are method names.
      *
-     * {@note There is no need to prefix the method names by classnames because a new instance of
-     *        <code>TestRunner</code> will be created for each test class, even if the the test
-     *        classes are aggregated in a <code>TestSuite</code>.}
+     * <div class="note"><b>Note:</b>
+     * There is no need to prefix the method names by classnames because a new instance of {@code TestRunner}
+     * will be created for each test class, even if the the test classes are aggregated in a {@link TestSuite}.</div>
      *
      * @see #addDependencyFailure(String)
      */

Modified: sis/branches/JDK6/core/sis-utility/src/test/java/org/apache/sis/test/XMLTestCase.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/core/sis-utility/src/test/java/org/apache/sis/test/XMLTestCase.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/core/sis-utility/src/test/java/org/apache/sis/test/XMLTestCase.java [UTF-8] (original)
+++ sis/branches/JDK6/core/sis-utility/src/test/java/org/apache/sis/test/XMLTestCase.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -114,8 +114,9 @@ public abstract strictfp class XMLTestCa
      * The (un)marshallers locale is set to {@link Locale#UK} (the language of ISO standards) and their
      * timezone is arbitrarily set to CET (<cite>Central European Time</cite>).
      *
-     * {@note We intentionally use a timezone different than UTC in order to have an error of one or two hours
-     *        if a code fails to take timezone offset in account.}
+     * <div class="note"><b>Note:</b>
+     * We intentionally use a timezone different than UTC in order to have an error of one or two hours
+     * if a code fails to take timezone offset in account.</div>
      *
      * @return The shared (un)marshaller pool.
      * @throws JAXBException If an error occurred while creating the JAXB marshaller.

Modified: sis/branches/JDK6/pom.xml
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/pom.xml?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/pom.xml (original)
+++ sis/branches/JDK6/pom.xml Thu Feb 27 12:13:03 2014
@@ -704,10 +704,7 @@ Apache SIS is a free software, Java lang
           </tags>
           <taglets>
             <taglet><tagletClass>org.apache.sis.internal.taglet.Module</tagletClass></taglet>
-            <taglet><tagletClass>org.apache.sis.internal.taglet.WebSite</tagletClass></taglet>
             <taglet><tagletClass>org.apache.sis.internal.taglet.Section</tagletClass></taglet>
-            <taglet><tagletClass>org.apache.sis.internal.taglet.Note</tagletClass></taglet>
-            <taglet><tagletClass>org.apache.sis.internal.taglet.Example</tagletClass></taglet>
             <taglet><tagletClass>org.apache.sis.internal.taglet.Preformat</tagletClass></taglet>
             <taglet><tagletClass>org.apache.sis.internal.taglet.SourceRepositoryURL</tagletClass></taglet>
           </taglets>

Modified: sis/branches/JDK6/src/main/javadoc/stylesheet.css
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/src/main/javadoc/stylesheet.css?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/src/main/javadoc/stylesheet.css (original)
+++ sis/branches/JDK6/src/main/javadoc/stylesheet.css Thu Feb 27 12:13:03 2014
@@ -59,6 +59,8 @@ table.sis tr td.sep {
  * This table has no border. Headers are still centered and other cells left-aligned.
  */
 table.compact {
+  margin-top:     6pt;
+  margin-bottom:  6pt;
   width:          auto;
   border:         none;
   border-spacing: 0pt;
@@ -135,6 +137,16 @@ div.block pre {
   font-family: Andale Mono, Courier New, monospace;
 }
 
+/*
+ * Note, examples or warnings.
+ */
+div.note {
+  font-size: small;
+  margin-left:  30pt;
+  margin-top:    9pt;
+  margin-bottom: 9pt;
+}
+
 
 
 

Modified: sis/branches/JDK6/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/AttributeNames.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/AttributeNames.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/AttributeNames.java [UTF-8] (original)
+++ sis/branches/JDK6/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/AttributeNames.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -411,11 +411,12 @@ public class AttributeNames {
      *   <td>           {@link Role#PUBLISHER}</td>
      * </tr></table>
      *
-     * {@note The member names in this class are upper-cases because they should be considered
-     *        as constants. For example <code>AttributeNames.CREATOR.EMAIL</code> maps exactly to the
-     *        <code>"creator_email"</code> string and nothing else. A lower-case <code>email</code>
-     *        member name could be misleading since it would suggest that the field contains the
-     *        actual name value rather than the key by which the value is identified in a NetCDF file.}
+     * <div class="note"><b>Note:</b>
+     * The member names in this class are upper-cases because they should be considered as constants.
+     * For example {@code AttributeNames.CREATOR.EMAIL} maps exactly to the {@code "creator_email"} string
+     * and nothing else. A lower-case {@code email} member name could be misleading since it would suggest
+     * that the field contains the actual name value rather than the key by which the value is identified
+     * in a NetCDF file.</div>
      *
      * @author  Martin Desruisseaux (Geomatys)
      * @since   0.3 (derived from geotk-3.20)
@@ -707,12 +708,12 @@ public class AttributeNames {
      *   <td            >{@link DimensionNameType#TIME}</td>
      * </tr></table>
      *
-     * {@note The member names in this class are upper-cases because they should be considered
-     *        as constants. For example <code>AttributeNames.LATITUDE.MINIMUM</code> maps exactly to
-     *        the <code>"geospatial_lat_min"</code> string and nothing else. A lower-case
-     *        <code>minimum</code> member name could be misleading since it would suggest that
-     *        the field contains the actual name value rather than the key by which the value
-     *        is identified in a NetCDF file.}
+     * <div class="note"><b>Note:</b>
+     * The member names in this class are upper-cases because they should be considered as constants.
+     * For example {@code AttributeNames.LATITUDE.MINIMUM} maps exactly to the {@code "geospatial_lat_min"}
+     * string and nothing else. A lower-case {@code minimum} member name could be misleading since it would
+     * suggest that the field contains the actual name value rather than the key by which the value is
+     * identified in a NetCDF file.</div>
      *
      * @author  Martin Desruisseaux (Geomatys)
      * @since   0.3 (derived from geotk-3.20)

Modified: sis/branches/JDK6/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/package-info.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/package-info.java [UTF-8] (original)
+++ sis/branches/JDK6/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/package-info.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -16,7 +16,7 @@
  */
 
 /**
- * Maps ISO metadata elements from/to the <a href="http://www.cfconventions.org">CF-compliant</a>
+ * Maps ISO metadata elements from/to the <a href="http://www.cfconventions.org">Climate and Forecast (CF)</a>
  * attributes in a NetCDF file. The mapping is defined in the following web pages:
  *
  * <ul>
@@ -28,6 +28,25 @@
  * The NetCDF attributes recognized by this package are listed in the
  * {@link org.apache.sis.storage.netcdf.AttributeNames} class.
  *
+ * {@section Note on the definition of terms}
+ * The UCAR library sometime uses the same words than the ISO/OGC standards for different things.
+ * In particular the words "<cite>domain</cite>" and "<cite>range</cite>" can be applied to arbitrary functions,
+ * and the UCAR library chooses to apply it to the function that converts grid indices to geodetic coordinates.
+ * The ISO 19123 standard on the other hand considers coverage as a function, and applies those <cite>domain</cite>
+ * and <cite>range</cite> words to that function. More specifically:
+ *
+ * <ul>
+ *   <li>UCAR "<cite>coordinate system</cite>" is actually a mix of <cite>coordinate system</cite>,
+ *       <cite>coordinate reference system</cite> and <cite>grid geometry</cite> in OGC sense.</li>
+ *   <li>UCAR coordinate system "<cite>domain</cite>" is not equivalent to ISO 19123 coverage domain,
+ *       but is rather related to <cite>grid envelope</cite>.</li>
+ *   <li>ISO 19123 coverage <cite>domain</cite> is related to UCAR coordinate system "<cite>range</cite>".</li>
+ *   <li>ISO 19123 coverage <cite>range</cite> is not equivalent to UCAR "<cite>range</cite>",
+ *       but is rather related to the NetCDF variable's minimum and maximum values.</li>
+ * </ul>
+ *
+ * Care must be taken for avoiding confusion when using SIS and UCAR libraries together.
+ *
  * @author  Martin Desruisseaux (IRD, Geomatys)
  * @since   0.3 (derived from geotk-3.20)
  * @version 0.3

Modified: sis/branches/JDK6/storage/sis-netcdf/src/test/java/org/apache/sis/storage/netcdf/ConformanceTest.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/storage/sis-netcdf/src/test/java/org/apache/sis/storage/netcdf/ConformanceTest.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/storage/sis-netcdf/src/test/java/org/apache/sis/storage/netcdf/ConformanceTest.java [UTF-8] (original)
+++ sis/branches/JDK6/storage/sis-netcdf/src/test/java/org/apache/sis/storage/netcdf/ConformanceTest.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -55,10 +55,10 @@ public final strictfp class ConformanceT
      * Reads a metadata object from the given NetCDF file.
      * This method is invoked by the tests inherited from the {@code geoapi-test} module.
      *
-     * {@note The method name is "<code>wrap</code>" because the GeoAPI implementation maps the
-     *        metadata methods to <code>NetcdfFile.findAttribute(String)</code> method calls.
-     *        However in SIS implementation, the metadata object is fully created right at this
-     *        method invocation time.}
+     * <div class="note"><b>Note:</b>
+     * The method name is "{@code wrap}" because the GeoAPI implementation maps the metadata methods to
+     * {@code NetcdfFile.findAttribute(String)} method calls. However in SIS implementation, the metadata
+     * object is fully created right at this method invocation time.</div>
      *
      * @param  file The NetCDF file to wrap.
      * @return A metadata implementation created from the attributes found in the given file.

Modified: sis/branches/JDK6/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStoreRegistry.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK6/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStoreRegistry.java?rev=1572529&r1=1572528&r2=1572529&view=diff
==============================================================================
--- sis/branches/JDK6/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStoreRegistry.java [UTF-8] (original)
+++ sis/branches/JDK6/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStoreRegistry.java [UTF-8] Thu Feb 27 12:13:03 2014
@@ -29,8 +29,9 @@ import org.apache.sis.util.resources.Err
  * Storage objects are typically {@link java.io.File} or {@link javax.sql.DataSource} instances, but can also
  * be any other objects documented in the {@link StorageConnector} class.
  *
- * {@note This class is package-private for now in order to get more experience about what could be a good API.
- *        This class may become public in a future SIS version.}
+ * <div class="note"><b>API note:</b>
+ * This class is package-private for now in order to get more experience about what could be a good API.
+ * This class may become public in a future SIS version.</div>
  *
  * {@section Thread safety}
  * The same {@code DataStoreRegistry} instance can be safely used by many threads without synchronization



Mime
View raw message