sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1490350 - in /sis/branches/JDK7: core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/ core/sis-build-helper/src/site/apt/ core/sis-metadata/src/test/java/org/apache/sis/test/suite/ core/sis-referencing/src/test/java/org/apac...
Date Thu, 06 Jun 2013 16:36:42 GMT
Author: desruisseaux
Date: Thu Jun  6 16:36:41 2013
New Revision: 1490350

URL: http://svn.apache.org/r1490350
Log:
Documentation improvement (no code change).

Added:
    sis/branches/JDK7/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Example.java
      - copied, changed from r1490192, sis/branches/JDK7/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Note.java
Modified:
    sis/branches/JDK7/core/sis-build-helper/src/site/apt/index.apt
    sis/branches/JDK7/core/sis-metadata/src/test/java/org/apache/sis/test/suite/MetadataTestSuite.java
    sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/test/suite/ReferencingTestSuite.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/io/CompoundFormat.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/math/FunctionProperty.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/math/MathFunctions.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/ArraysExt.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/CharSequences.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/Deprecable.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverters.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/Static.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/Utilities.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/LoggerAdapter.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/WarningListener.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/WarningListeners.java
    sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/package-info.java
    sis/branches/JDK7/core/sis-utility/src/test/java/org/apache/sis/test/TestSuite.java
    sis/branches/JDK7/core/sis-utility/src/test/java/org/apache/sis/test/suite/UtilityTestSuite.java
    sis/branches/JDK7/storage/sis-netcdf/src/test/java/org/apache/sis/test/suite/NetcdfTestSuite.java
    sis/branches/JDK7/storage/sis-storage/src/test/java/org/apache/sis/storage/DataStoreConnectionTest.java
    sis/branches/JDK7/storage/sis-storage/src/test/java/org/apache/sis/test/suite/StorageTestSuite.java

Copied: sis/branches/JDK7/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Example.java
(from r1490192, sis/branches/JDK7/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Note.java)
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Example.java?p2=sis/branches/JDK7/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Example.java&p1=sis/branches/JDK7/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Note.java&r1=1490192&r2=1490350&rev=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Note.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Example.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -22,28 +22,28 @@ import com.sun.tools.doclets.Taglet;
 
 
 /**
- * The <code>@note</code> tag for inserting a note in a javadoc comment.
+ * The <code>@example</code> tag for inserting an example in a javadoc comment.
  *
  * @author  Martin Desruisseaux (Geomatys)
  * @since   0.3 (derived from geotk-3.00)
  * @version 0.3
  * @module
  */
-public final class Note extends InlineTaglet {
+public final class Example extends InlineTaglet {
     /**
      * Register this taglet.
      *
      * @param tagletMap the map to register this tag to.
      */
     public static void register(final Map<String,Taglet> tagletMap) {
-       final Note tag = new Note();
+       final Example tag = new Example();
        tagletMap.put(tag.getName(), tag);
     }
 
     /**
-     * Constructs a default <code>@note</code> taglet.
+     * Constructs a default <code>@example</code> taglet.
      */
-    private Note() {
+    private Example() {
         super();
     }
 
@@ -54,7 +54,7 @@ public final class Note extends InlineTa
      */
     @Override
     public String getName() {
-        return "note";
+        return "example";
     }
 
     /**
@@ -65,7 +65,7 @@ public final class Note extends InlineTa
      */
     @Override
     public String toString(final Tag tag) {
-        final StringBuilder buffer = new StringBuilder("<blockquote><font size=-1><b>Note:</b>\n");
+        final StringBuilder buffer = new StringBuilder("<blockquote><font size=-1><b>Example:</b>\n");
         buffer.append(tag.text());
         return buffer.append("</font></blockquote>").toString();
     }

Modified: sis/branches/JDK7/core/sis-build-helper/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-build-helper/src/site/apt/index.apt?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-build-helper/src/site/apt/index.apt [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-build-helper/src/site/apt/index.apt [UTF-8] Thu Jun  6 16:36:41
2013
@@ -33,6 +33,9 @@ Building Apache SIS
 | <<<\{@note\}>>>      | An inline taglet for a remark that readers can
safely ignore.                             |
 |                      | Notes appear as indented paragraphs with a smaller font.       
                          |
 *----------------------+-------------------------------------------------------------------------------------------+
+| <<<\{@example\}>>>   | An inline taglet for an example.             
                                            |
+|                      | Examples appear as indented paragraphs with a smaller font.    
                          |
+*----------------------+-------------------------------------------------------------------------------------------+
 | <<<\{@preformat\}>>> | An inline taglet for pre-formatted text. The first
word inside the taglet shall be one of |
 |                      | <<<java>>>, <<<xml>>>, <<<sql>>>,
<<<wkt>>>, <<<text>>>, <<<math>>> or
<<<shell>>>.       |
 *----------------------+-------------------------------------------------------------------------------------------+

Modified: sis/branches/JDK7/core/sis-metadata/src/test/java/org/apache/sis/test/suite/MetadataTestSuite.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/test/java/org/apache/sis/test/suite/MetadataTestSuite.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/test/java/org/apache/sis/test/suite/MetadataTestSuite.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/test/java/org/apache/sis/test/suite/MetadataTestSuite.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -56,7 +56,7 @@ import org.junit.BeforeClass;
 public final strictfp class MetadataTestSuite extends TestSuite {
     /**
      * Verifies the list of tests before to run the suite.
-     * See {@link #verifyTestList(Class, Class<?>[])} for more information.
+     * See {@link #verifyTestList(Class, Class[])} for more information.
      */
     @BeforeClass
     public static void verifyTestList() {

Modified: sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/test/suite/ReferencingTestSuite.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/test/suite/ReferencingTestSuite.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/test/suite/ReferencingTestSuite.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/test/suite/ReferencingTestSuite.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -43,7 +43,7 @@ import org.junit.BeforeClass;
 public final strictfp class ReferencingTestSuite extends TestSuite {
     /**
      * Verifies the list of tests before to run the suite.
-     * See {@link #verifyTestList(Class, Class<?>[])} for more information.
+     * See {@link #verifyTestList(Class, Class[])} for more information.
      */
     @BeforeClass
     public static void verifyTestList() {

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/io/CompoundFormat.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/io/CompoundFormat.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/io/CompoundFormat.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/io/CompoundFormat.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -160,12 +160,10 @@ public abstract class CompoundFormat<T> 
      *       error index</var> + <var>{@code ParseException} error offset</var>.</li>
      * </ul>
      *
-     * <blockquote><font size="-1"><b>Example:</b>
-     * If parsing of the {@code "30.0 40,0"} coordinate fails on the coma in the last number,
-     * then the {@code pos} error index will be set to 5 (the beginning of the {@code "40.0"}
-     * character sequence) while the {@code ParseException} error offset will be set to 2
-     * (the coma position relative the the beginning of the {@code "40.0"} character sequence).
-     * </font></blockquote>
+     * {@example If parsing of the <code>"30.0 40,0"</code> coordinate fails
on the coma in the last number, then the
+     * <code>pos</code> error index will be set to 5 (the beginning of the <code>"40.0"</code>
character sequence)
+     * while the <code>ParseException</code> error offset will be set to 2 (the
coma position relative the beginning
+     * of the <code>"40.0"</code> character sequence).}
      *
      * This error offset policy is a consequence of the compound nature of {@code CompoundFormat},
      * since the exception may have been produced by a call to {@link Format#parseObject(String)}.

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/math/FunctionProperty.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/math/FunctionProperty.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/math/FunctionProperty.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/math/FunctionProperty.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -78,10 +78,8 @@ public enum FunctionProperty {
      * A function is <cite>injective</cite> if each value of <var>T</var>
is either unrelated
      * to <var>S</var>, or is the output of exactly one value of <var>S</var>.
      *
-     * <blockquote><font size="-1"><b>Example:</b>
-     * A {@code ObjectConverter} doing conversions from {@code Integer} to {@code String}
is an
-     * injective function, because no pair of integers can produce the same string.
-     * </font></blockquote>
+     * {@example A <code>ObjectConverter</code> doing conversions from <code>Integer</code>
to <code>String</code>
+     * is an injective function, because no pair of integers can produce the same string.}
      *
      * A function which is both injective and {@linkplain #SURJECTIVE surjective} is a
      * <cite>bijective</cite> function. In such functions, there is a one-to-one
relationship
@@ -96,12 +94,9 @@ public enum FunctionProperty {
      * A function is <cite>surjective</cite> if any value of <var>T</var>
can be created
      * from one or many values of <var>S</var>.
      *
-     * <blockquote><font size="-1"><b>Example:</b>
-     * A {@code ObjectConverter} doing conversions from {@link String} to {@link Integer}
is a
-     * surjective function, since there is always at least one string for each integer value.
-     * Note that such function can not be {@linkplain #INJECTIVE injective} since many different
-     * strings can represent the same integer value.
-     * </font></blockquote>
+     * {@example A <code>ObjectConverter</code> doing conversions from <code>String</code>
to <code>Integer</code>
+     * is a surjective function, since there is always at least one string for each integer
value. Note that such
+     * function can not be injective since many different strings can represent the same
integer value.}
      *
      * A function which is both {@linkplain #INJECTIVE injective} and surjective is a
      * <cite>bijective</cite> function. In such functions, there is a one-to-one
relationship

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/math/MathFunctions.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/math/MathFunctions.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/math/MathFunctions.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/math/MathFunctions.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -222,13 +222,12 @@ public final class MathFunctions extends
      *       increases the number of needed fraction digits in order to prevent the rounded
      *       number to be collapsed into the next integer value.
      *
-     *       <blockquote><font size="-1"><b>Example:</b>
+     *       {@example
      *       If {@code accuracy} is 0.95, then a return value of 1 is not sufficient since
the
      *       rounded value of 0.95 with 1 fraction digit would be 1.0. Such value would be
a
      *       violation of this method contract since the difference between 0 and that formatted
      *       value would be greater than the accuracy. Note that this is not an artificial
rule;
-     *       this is related to the fact that 0.9999… is mathematically strictly equals
to 1.
-     *       </font></blockquote></li>
+     *       this is related to the fact that 0.9999… is mathematically strictly equals
to 1.}</li>
      * </ul>
      *
      * <p>Invoking this method is equivalent to computing <code>(int)

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/ArraysExt.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/ArraysExt.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/ArraysExt.java [UTF-8]
(original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/ArraysExt.java [UTF-8]
Thu Jun  6 16:36:41 2013
@@ -31,7 +31,7 @@ import java.util.Objects;
  *
  * <ul>
  *   <li>The {@link #resize(Object[], int) resize} methods, which are very similar
to the
- *       {@link Arrays#copyOf(Object[], int) Arrays.copyOf} methods except that they accept
+ *       {@link Arrays#copyOf(Object[], int) Arrays.copyOf(…)} methods except that they
accept
  *       {@code null} arrays and do not copy anything if the given array already has the
  *       requested length.</li>
  *   <li>The {@link #insert(Object[], int, Object[], int, int) insert} and {@link #remove(Object[],

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/CharSequences.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/CharSequences.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/CharSequences.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/CharSequences.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -48,14 +48,12 @@ import static org.apache.sis.util.String
  *       feeds or tabulations are entity boundaries.</li>
  * </ul>
  *
- * <blockquote><font size="-1"><b>Example:</b> Numbers formatted
in the French locale use no-break
- * spaces as group separators. When parsing a list of numbers, ordinary spaces around the
numbers
- * may need to be ignored, but no-break spaces shall be considered as part of the numbers.
- * Consequently {@code isWhitespace(…)} is appropriate for skipping spaces <em>between</em>
the numbers.
- * But if there is spaces to skip <em>inside</em> a single number, then {@code
isSpaceChar(…)} is a
- * good choice for accepting no-break spaces and for stopping the parse operation at tabulations
or
- * line feed character. A tabulation or line feed between two characters is very likely to
separate
- * two distinct values.</font></blockquote>
+ * {@example Numbers formatted in the French locale use no-break spaces as group separators.
When parsing a list
+ * of numbers, ordinary spaces around the numbers may need to be ignored, but no-break spaces
shall be considered as
+ * part of the numbers. Consequently <code>isWhitespace(…)</code> is appropriate
for skipping spaces <em>between</em>
+ * the numbers. But if there is spaces to skip <em>inside</em> a single number,
then <code>isSpaceChar(…)</code> is a
+ * good choice for accepting no-break spaces and for stopping the parse operation at tabulations
or line feed character.
+ * A tabulation or line feed between two characters is very likely to separate two distinct
values.}
  *
  * In practice, the {@link java.text.Format} implementations in the SIS library typically
use
  * {@code isSpaceChar(…)} while most of the rest of the SIS library, including this

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/Deprecable.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/Deprecable.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/Deprecable.java [UTF-8]
(original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/Deprecable.java [UTF-8]
Thu Jun  6 16:36:41 2013
@@ -20,8 +20,16 @@ import org.opengis.util.InternationalStr
 
 
 /**
- * Interface of classes for which deprecated instances may exist. Deprecated instances exist
in some
- * {@linkplain org.opengis.referencing.AuthorityFactory authority factories} like the EPSG
database.
+ * Interface of classes for which deprecated instances may exist. Despite the name, the entities
deprecated
+ * by this interface are unrelated to the entities deprecated by the Java {@link Deprecated}
annotation.
+ * This interface is for identifying deprecated <em>data</em> rather than language
constructs.
+ *
+ * {@example When an error is discovered in the definition of a Coordinate Reference System
(CRS) in the EPSG
+ * database, the EPSG maintainers do not change the data. Instead, they deprecate the erroneous
definition
+ * and create a new one with a new EPSG code. The <code>isDeprecated()</code>
method in this interface allows
+ * users to identify CRS instances created from such deprecated database records, for example
in order to log
+ * a warning when data are projected to a deprecated CRS.}
+ *
  * Some examples of deprecated instances are:
  *
  * <ul>

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -54,6 +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.
+ * 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.}
+ *
  * Below are some guidelines about the function properties that a converter can declare:
  *
  * <ul>
@@ -71,6 +77,8 @@ import org.apache.sis.internal.jdk8.Func
  * @since   0.3
  * @version 0.3
  * @module
+ *
+ * @see ObjectConverters
  */
 public interface ObjectConverter<S,T> extends Function<S,T> {
     /**

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverters.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverters.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverters.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverters.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -61,6 +61,8 @@ import org.apache.sis.internal.converter
  * @since   0.3 (derived from geotk-3.00)
  * @version 0.3
  * @module
+ *
+ * @see ObjectConverter
  */
 public final class ObjectConverters extends Static {
     /**

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/Static.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/Static.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/Static.java [UTF-8]
(original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/Static.java [UTF-8]
Thu Jun  6 16:36:41 2013
@@ -48,6 +48,8 @@ package org.apache.sis.util;
  *         and test if a unit is angular, linear or temporal.</td></tr>
  *
  * <tr><th colspan="2" class="hsep">OGC/ISO objects (metadata, referencing, geometries)</th></tr>
+ * <tr><td>{@link org.apache.sis.util.iso.Types}</td>
+ *     <td>Provide UML identifier and description for GeoAPI types.</td></tr>
  * <tr><td>{@link org.apache.sis.metadata.iso.extent.Extents}</td>
  *     <td>Extract information from {@link org.opengis.metadata.extent.Extent} objects.</td></tr>
  * <tr><td>{@link org.apache.sis.geometry.Envelopes}</td>
@@ -58,6 +60,8 @@ package org.apache.sis.util;
  *     <td>Methods working on {@link Appendable} instances.</td></tr>
  * <tr><td>{@link org.apache.sis.xml.XML}</td>
  *     <td>Marshal or unmarshal ISO 19115 objects.</td></tr>
+ * <tr><td>{@link org.apache.sis.xml.Namespaces}</td>
+ *     <td>{@code String} constants for commonly used namespaces.</td></tr>
  *
  * <tr><th colspan="2" class="hsep">Loggings and exceptions</th></tr>
  * <tr><td>{@link ArgumentChecks}</td>

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/Utilities.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/Utilities.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/Utilities.java [UTF-8]
(original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/Utilities.java [UTF-8]
Thu Jun  6 16:36:41 2013
@@ -28,7 +28,7 @@ import java.util.Objects;
 
 
 /**
- * Miscellaneous static methods.
+ * Static methods for object comparisons in different ways (deeply, approximatively, <i>etc</i>).
  *
  * @author Martin Desruisseaux (IRD, Geomatys)
  * @since   0.3 (derived from geotk-1.2)

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -225,11 +225,9 @@ 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.
          *
-         * <blockquote><font size="-1"><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.</font></blockquote>
+         * {@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.}
          *
          * @return Any object stored at this node by the user, or {@code null} if none.
          * @category tree

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/LoggerAdapter.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/LoggerAdapter.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/LoggerAdapter.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/LoggerAdapter.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -137,7 +137,8 @@ public abstract class LoggerAdapter exte
     public abstract Level getLevel();
 
     /**
-     * Returns the level for {@link #entering}, {@link #exiting} and {@link #throwing} methods.
+     * Returns the level for {@link #entering(String, String) entering(…)}, {@link #exiting(String,
String) exiting(…)}
+     * and {@link #throwing(String, String, Throwable) throwing(…)} methods.
      * The default implementation returns {@link Level#FINER}, which is consistent with the
      * value used in the JDK logging framework. Subclasses should override this method if
      * a different debug level is wanted.

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/WarningListener.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/WarningListener.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/WarningListener.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/WarningListener.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -41,6 +41,7 @@ import java.util.logging.LogRecord;
  * @version 0.3
  * @module
  *
+ * @see WarningListeners
  * @see org.apache.sis.storage.DataStore#addWarningListener(WarningListener)
  */
 public interface WarningListener<S> extends EventListener {

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/WarningListeners.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/WarningListeners.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/WarningListeners.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/logging/WarningListeners.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -48,6 +48,9 @@ import org.apache.sis.util.resources.Err
  * @since   0.3
  * @version 0.3
  * @module
+ *
+ * @see WarningListener
+ * @see org.apache.sis.storage.AbstractDataStore#listeners
  */
 @ThreadSafe
 public class WarningListeners<S> implements Localized {

Modified: sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/package-info.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-utility/src/main/java/org/apache/sis/util/package-info.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -16,23 +16,25 @@
  */
 
 /**
- * Simple data objects and miscellaneous utilities. This package provides:
+ * Simple data objects and miscellaneous utilities.
+ * This package provides general purpose static methods working on primitive or basic Java
types
+ * ({@link org.apache.sis.util.Characters},
+ *  {@link org.apache.sis.util.CharSequences},
+ *  {@link org.apache.sis.util.StringBuilders},
+ *  {@link org.apache.sis.util.Locales},
+ *  {@link org.apache.sis.util.Numbers},
+ *  {@link org.apache.sis.util.Classes}), arrays
+ * ({@link org.apache.sis.util.ArraysExt}) or other standard Java types
+ * ({@link org.apache.sis.util.Exceptions}).
  *
+ * It defines also general purpose annotations, enumerations and exceptions.
+ *
+ * <p>Some other noticeable services are:</p>
  * <ul>
- *   <li>General purpose static methods working on:
- *   <ul>
- *     <li>Primitive or basic Java types:
- *         {@link org.apache.sis.util.Characters},
- *         {@link org.apache.sis.util.CharSequences},
- *         {@link org.apache.sis.util.StringBuilders},
- *         {@link org.apache.sis.util.Locales},
- *         {@link org.apache.sis.util.Numbers},
- *         {@link org.apache.sis.util.Classes}.</li>
- *     <li>Arrays:
- *         {@link org.apache.sis.util.ArraysExt}.</li>
- *     <li>Other standard Java types:
- *         {@link org.apache.sis.util.Exceptions}.</li>
- *   </ul></li>
+ *   <li>{@link org.apache.sis.util.ObjectConverters}, together with the
+ *       {@link org.apache.sis.util.ObjectConverter} interface, for converting various kind
of objects.</li>
+ *   <li>{@link org.apache.sis.util.Utilities}, together with the
+ *       {@link org.apache.sis.util.LenientComparable} interface, for comparing objects in
various ways.</li>
  * </ul>
  *
  * @author Martin Desruisseaux (Geomatys)

Modified: sis/branches/JDK7/core/sis-utility/src/test/java/org/apache/sis/test/TestSuite.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/test/java/org/apache/sis/test/TestSuite.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/test/java/org/apache/sis/test/TestSuite.java [UTF-8]
(original)
+++ sis/branches/JDK7/core/sis-utility/src/test/java/org/apache/sis/test/TestSuite.java [UTF-8]
Thu Jun  6 16:36:41 2013
@@ -37,7 +37,7 @@ import static org.junit.Assert.*;
 public abstract strictfp class TestSuite {
     /**
      * The default set of base classes that all test cases are expected to extends.
-     * This is the usual argument value to the {@link #verifyTestList(Class, Class<?>[])}
method.
+     * This is the usual argument value to the {@link #verifyTestList(Class, Class[])} method.
      */
     protected static final Class<?>[] BASE_TEST_CLASSES = {
         TestCase.class,

Modified: sis/branches/JDK7/core/sis-utility/src/test/java/org/apache/sis/test/suite/UtilityTestSuite.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-utility/src/test/java/org/apache/sis/test/suite/UtilityTestSuite.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-utility/src/test/java/org/apache/sis/test/suite/UtilityTestSuite.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-utility/src/test/java/org/apache/sis/test/suite/UtilityTestSuite.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -116,7 +116,7 @@ import org.junit.BeforeClass;
 public final strictfp class UtilityTestSuite extends TestSuite {
     /**
      * Verifies the list of tests before to run the suite.
-     * See {@link #verifyTestList(Class, Class<?>[])} for more information.
+     * See {@link #verifyTestList(Class, Class[])} for more information.
      */
     @BeforeClass
     public static void verifyTestList() {

Modified: sis/branches/JDK7/storage/sis-netcdf/src/test/java/org/apache/sis/test/suite/NetcdfTestSuite.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/storage/sis-netcdf/src/test/java/org/apache/sis/test/suite/NetcdfTestSuite.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/storage/sis-netcdf/src/test/java/org/apache/sis/test/suite/NetcdfTestSuite.java
[UTF-8] (original)
+++ sis/branches/JDK7/storage/sis-netcdf/src/test/java/org/apache/sis/test/suite/NetcdfTestSuite.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -46,7 +46,7 @@ import org.junit.BeforeClass;
 public final strictfp class NetcdfTestSuite extends TestSuite {
     /**
      * Verifies the list of tests before to run the suite.
-     * See {@link #verifyTestList(Class, Class<?>[])} for more information.
+     * See {@link #verifyTestList(Class, Class[])} for more information.
      */
     @BeforeClass
     public static void verifyTestList() {

Modified: sis/branches/JDK7/storage/sis-storage/src/test/java/org/apache/sis/storage/DataStoreConnectionTest.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/storage/sis-storage/src/test/java/org/apache/sis/storage/DataStoreConnectionTest.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/storage/sis-storage/src/test/java/org/apache/sis/storage/DataStoreConnectionTest.java
[UTF-8] (original)
+++ sis/branches/JDK7/storage/sis-storage/src/test/java/org/apache/sis/storage/DataStoreConnectionTest.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -151,8 +151,8 @@ public final strictfp class DataStoreCon
     /**
      * Tests the {@link DataStoreConnection#getStorageAs(Class)} method for the {@link ChannelDataInput}
type.
      * The initial value should not be an instance of {@link ChannelImageInputStream} in
order to avoid initializing
-     * the Image I/O classes. However after a call to {@getStorageAt(ChannelImageInputStream.class)},
the type should
-     * have been promoted.
+     * the Image I/O classes. However after a call to {@code getStorageAt(ChannelImageInputStream.class)},
the type
+     * should have been promoted.
      *
      * @throws DataStoreException Should never happen.
      * @throws IOException If an error occurred while reading the test file.
@@ -195,7 +195,7 @@ public final strictfp class DataStoreCon
 
     /**
      * Tests the {@link DataStoreConnection#getStorageAs(Class)} method for the {@link ByteBuffer}
type when
-     * the buffer is only temporary. The difference between this test and {@link testGetAsByteBuffer()}
is
+     * the buffer is only temporary. The difference between this test and {@link #testGetAsByteBuffer()}
is
      * that the buffer created in this test will not be used for the "real" reading process
in the data store.
      * Consequently, it should be a smaller, only temporary, buffer.
      *

Modified: sis/branches/JDK7/storage/sis-storage/src/test/java/org/apache/sis/test/suite/StorageTestSuite.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/storage/sis-storage/src/test/java/org/apache/sis/test/suite/StorageTestSuite.java?rev=1490350&r1=1490349&r2=1490350&view=diff
==============================================================================
--- sis/branches/JDK7/storage/sis-storage/src/test/java/org/apache/sis/test/suite/StorageTestSuite.java
[UTF-8] (original)
+++ sis/branches/JDK7/storage/sis-storage/src/test/java/org/apache/sis/test/suite/StorageTestSuite.java
[UTF-8] Thu Jun  6 16:36:41 2013
@@ -38,7 +38,7 @@ import org.junit.BeforeClass;
 public final strictfp class StorageTestSuite extends TestSuite {
     /**
      * Verifies the list of tests before to run the suite.
-     * See {@link #verifyTestList(Class, Class<?>[])} for more information.
+     * See {@link #verifyTestList(Class, Class[])} for more information.
      */
     @BeforeClass
     public static void verifyTestList() {



Mime
View raw message