Author: desruisseaux
Date: Wed Feb 6 12:12:59 2013
New Revision: 1442921
URL: http://svn.apache.org/viewvc?rev=1442921&view=rev
Log:
Minor javadoc fixes.
Modified:
sis/branches/JDK7/sis-referencing/src/test/java/org/apache/sis/geometry/DirectPosition1DTest.java
sis/branches/JDK7/sis-referencing/src/test/java/org/apache/sis/geometry/DirectPosition2DTest.java
sis/branches/JDK7/sis-referencing/src/test/java/org/apache/sis/geometry/GeneralDirectPositionTest.java
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/io/TableAppender.java
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CollectionsExt.java
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/UnmodifiableArrayList.java
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/iso/ResourceInternationalString.java
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/MarshalContext.java
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/NilObject.java
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/ValueConverter.java
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/CharSequencesTest.java
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/CharactersTest.java
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/ClassesTest.java
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/collection/DerivedMapTest.java
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/iso/AbstractNameTest.java
Modified:
sis/branches/JDK7/sis-referencing/src/test/java/org/apache/sis/geometry/DirectPosition1DTest.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-referencing/src/test/java/org/apache/sis/geometry/DirectPosition1DTest.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-referencing/src/test/java/org/apache/sis/geometry/DirectPosition1DTest.java
(original)
+++
sis/branches/JDK7/sis-referencing/src/test/java/org/apache/sis/geometry/DirectPosition1DTest.java
Wed Feb 6 12:12:59 2013
@@ -46,7 +46,7 @@ public final strictfp class DirectPositi
}
/**
- * Tests the {@link DirectPosition1D#DirectPosition2D(String)} constructor.
+ * Tests the {@link DirectPosition1D#DirectPosition1D(CharSequence)}
constructor.
*/
@Test
public void testWktParsing() {
Modified:
sis/branches/JDK7/sis-referencing/src/test/java/org/apache/sis/geometry/DirectPosition2DTest.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-referencing/src/test/java/org/apache/sis/geometry/DirectPosition2DTest.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-referencing/src/test/java/org/apache/sis/geometry/DirectPosition2DTest.java
(original)
+++
sis/branches/JDK7/sis-referencing/src/test/java/org/apache/sis/geometry/DirectPosition2DTest.java
Wed Feb 6 12:12:59 2013
@@ -46,7 +46,7 @@ public final strictfp class DirectPositi
}
/**
- * Tests the {@link DirectPosition2D#DirectPosition2D(String)} constructor.
+ * Tests the {@link DirectPosition2D#DirectPosition2D(CharSequence)}
constructor.
*/
@Test
public void testWktParsing() {
Modified:
sis/branches/JDK7/sis-referencing/src/test/java/org/apache/sis/geometry/GeneralDirectPositionTest.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-referencing/src/test/java/org/apache/sis/geometry/GeneralDirectPositionTest.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-referencing/src/test/java/org/apache/sis/geometry/GeneralDirectPositionTest.java
(original)
+++
sis/branches/JDK7/sis-referencing/src/test/java/org/apache/sis/geometry/GeneralDirectPositionTest.java
Wed Feb 6 12:12:59 2013
@@ -61,7 +61,7 @@ public final strictfp class GeneralDirec
}
/**
- * Tests the {@link GeneralDirectPosition#GeneralDirectPosition(String)}
constructor.
+ * Tests the {@link
GeneralDirectPosition#GeneralDirectPosition(CharSequence)} constructor.
*/
@Test
public void testWktParsing() {
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/io/TableAppender.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/io/TableAppender.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/io/TableAppender.java
(original)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/io/TableAppender.java
Wed Feb 6 12:12:59 2013
@@ -74,7 +74,7 @@ import static org.apache.sis.util.Charac
* @version 0.3
* @module
*
- * @see org.apache.sis.util.tree.TreeTableFormat
+ * @see org.apache.sis.util.collection.TreeTableFormat
*/
@Decorator(Appendable.class)
public class TableAppender extends Appender implements Flushable {
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CollectionsExt.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CollectionsExt.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CollectionsExt.java
(original)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CollectionsExt.java
Wed Feb 6 12:12:59 2013
@@ -128,7 +128,7 @@ public final class CollectionsExt extend
* <p>The {@link Set#add(Object) Set.add(E)} method is supported only if
the given converter
* is {@linkplain org.apache.sis.math.FunctionProperty#INVERTIBLE
invertible}.
* An invertible converter is not mandatory for other {@code Set}
operations.
- * However {@link Set#contains(Object) contains} and {@link
#remove(Object) remove}
+ * However {@link Set#contains(Object) contains} and {@link
Set#remove(Object) remove}
* operations are likely to be faster if the inverse converter is
available.</p>
*
* <p>The derived set may contain fewer elements than the original set if
some elements
@@ -619,7 +619,7 @@ public final class CollectionsExt extend
}
/**
- * Returns a comparator for map entries having comparable {@linkplain
Map.Entry#getValue() values}.
+ * Returns a comparator for map entries having comparable {@linkplain
java.util.Map.Entry#getValue() values}.
* For any pair of entries {@code e1} and {@code e2}, this method performs
the comparison as below:
*
* {@preformat java
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java
(original)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java
Wed Feb 6 12:12:59 2013
@@ -506,8 +506,8 @@ public class DefaultTreeTable implements
/**
* Adds a new child in the {@linkplain #getChildren() children list}.
- * The default implementation delegates to {@link #Node(Node)}, which
- * has the following implications:
+ * The default implementation delegates to {@link Node#Node(Node)},
+ * which has the following implications:
*
* <ul>
* <li>The new node inherits the columns of this node, on the
assumption that
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/UnmodifiableArrayList.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/UnmodifiableArrayList.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/UnmodifiableArrayList.java
(original)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/UnmodifiableArrayList.java
Wed Feb 6 12:12:59 2013
@@ -63,7 +63,7 @@ public class UnmodifiableArrayList<E> ex
* retained (i.e. the array is <strong>not</strong> cloned). Consequently
the given array
* shall not be modified after construction if this list is intended to be
immutable.
*
- * <p>This constructor is for sub-classing only. Users should invoke the
{@link #wrap(E[])}
+ * <p>This constructor is for sub-classing only. Users should invoke the
{@link #wrap(Object[])}
* static method instead.</p>
*
* @param array The array to wrap.
@@ -255,7 +255,7 @@ public class UnmodifiableArrayList<E> ex
* @return A view of the specified range within this list.
* @throws IndexOutOfBoundsException If the lower or upper value are out
of bounds.
*
- * @see #wrap(E[], int, int)
+ * @see #wrap(Object[], int, int)
*/
@Override
public UnmodifiableArrayList<E> subList(final int lower, final int upper)
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/iso/ResourceInternationalString.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/iso/ResourceInternationalString.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/iso/ResourceInternationalString.java
(original)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/iso/ResourceInternationalString.java
Wed Feb 6 12:12:59 2013
@@ -107,9 +107,8 @@ public class ResourceInternationalString
/**
* Returns the resource bundle for the given locale. The default
implementation fetches the
- * bundle from the name given at {@linkplain
#ResourceInternationalString(String,String)
- * construction time}. Subclasses can override this method if they need to
fetch the
- * bundle in an other way.
+ * bundle from the name given at {@linkplain #ResourceInternationalString
construction time}.
+ * Subclasses can override this method if they need to fetch the bundle in
an other way.
*
* @param locale The locale for which to get the resource bundle.
* @return The resource bundle for the given locale.
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/MarshalContext.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/MarshalContext.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/MarshalContext.java
(original)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/MarshalContext.java
Wed Feb 6 12:12:59 2013
@@ -72,8 +72,8 @@ public abstract class MarshalContext {
* formatted according ISO standard instead than the rules of the English
locale.
*
* {@section Handling of <code>null</code> locale}
- * A {@code null} value means that the locale is unspecified. Caller is
free to
- * use the root locale, the system default or any other locale.
+ * A {@code null} value means that the locale is unspecified. Callers are
encouraged
+ * to use the root locale as the default value, but some flexibility is
allowed.
*
* @return The locale for the XML fragment being (un)marshalled, or {@code
null} is unspecified.
*
@@ -83,7 +83,11 @@ public abstract class MarshalContext {
/**
* Returns the timezone to use for (un)marshalling, or {@code null} if
none were explicitely
- * specified. If {@code null}, then the caller is free to use the timezone
of its choice.
+ * specified.
+ *
+ * {@section Handling of <code>null</code> timezone}
+ * A {@code null} value means that the timezone is unspecified. Callers
are encouraged
+ * to use the UTC timezone as the default value, but some flexibility is
allowed.
*
* @return The timezone for the XML fragment being (un)marshalled, or
{@code null} if unspecified.
*/
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/NilObject.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/NilObject.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/NilObject.java
(original)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/NilObject.java
Wed Feb 6 12:12:59 2013
@@ -74,7 +74,6 @@ package org.apache.sis.xml;
* @module
*
* @see NilReason#createNilObject(Class)
- * @see ReferenceResolver#resolve(MarshalContext, Class, NilReason)
* @see org.apache.sis.util.Numbers#valueOfNil(Class)
*/
public interface NilObject {
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/ValueConverter.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/ValueConverter.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/ValueConverter.java
(original)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/ValueConverter.java
Wed Feb 6 12:12:59 2013
@@ -97,7 +97,7 @@ public class ValueConverter {
* @param value The value that can't be converted.
* @param sourceType The base type of the value to convert. This is
determined by the argument
* type of the method that caught the exception. For example the
source type is always
- * {@code URI.class} if the exception has been caught by the
{@link #toURL(URI)} method.
+ * {@code URI.class} if the exception has been caught by the
{@link #toURL(MarshalContext, URI)} method.
* @param targetType The expected type of the converted object.
* @param exception The exception that occurred during the conversion
attempt.
* @return {@code true} if the (un)marshalling process should continue
despite this error,
Modified:
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/CharSequencesTest.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/CharSequencesTest.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/CharSequencesTest.java
(original)
+++
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/CharSequencesTest.java
Wed Feb 6 12:12:59 2013
@@ -76,8 +76,8 @@ public final strictfp class CharSequence
}
/**
- * Tests the {@link CharSequences#indexOf(CharSequence, CharSequence,
int)} method.
- * We test four time with different kind of character sequences.
+ * Tests the {@link CharSequences#indexOf(CharSequence, CharSequence, int,
int)} method.
+ * We test four times with different kind of character sequences.
*/
@Test
public void testIndexOf() {
@@ -100,9 +100,9 @@ public final strictfp class CharSequence
}
/**
- * Tests the {@link CharSequences#indexOf(CharSequence, int, int)} and
- * {@link CharSequences#lastIndexOf(CharSequence, int, int)} methods.
- * We test two time with different kind of character sequences, in order
+ * Tests the {@link CharSequences#indexOf(CharSequence, int, int, int)} and
+ * {@link CharSequences#lastIndexOf(CharSequence, int, int, int)} methods.
+ * We test two times with different kind of character sequences, in order
* to test the {@link String} optimization case.
*/
@Test
@@ -359,7 +359,7 @@ public final strictfp class CharSequence
}
/**
- * Tests the {@link CharSequences#isUpperCase(CharSequence)} method.
+ * Tests the {@link CharSequences#isUpperCase(CharSequence, int, int)}
method.
*/
@Test
public void testIsUpperCase() {
Modified:
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/CharactersTest.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/CharactersTest.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/CharactersTest.java
(original)
+++
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/CharactersTest.java
Wed Feb 6 12:12:59 2013
@@ -107,7 +107,7 @@ public final strictfp class CharactersTe
}
/**
- * Tests the {@link Characters.Filter#forTypes(byte[])} method.
+ * Tests the {@link
org.apache.sis.util.Characters.Filter#forTypes(byte[])} method.
*/
@Test
public void testFilterForTypes() {
Modified:
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/ClassesTest.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/ClassesTest.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/ClassesTest.java
(original)
+++
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/ClassesTest.java
Wed Feb 6 12:12:59 2013
@@ -16,6 +16,7 @@
*/
package org.apache.sis.util;
+import java.lang.reflect.Field;
import org.junit.Test;
import org.apache.sis.test.TestCase;
@@ -184,7 +185,7 @@ public final strictfp class ClassesTest
}
/**
- * Tests the {@link #boundOfParameterizedAttribute} method.
+ * Tests the {@link Classes#boundOfParameterizedAttribute(Field)} method.
*
* @throws NoSuchFieldException Should never occur.
* @throws NoSuchMethodException Should never occur.
Modified:
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/collection/DerivedMapTest.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/collection/DerivedMapTest.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/collection/DerivedMapTest.java
(original)
+++
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/collection/DerivedMapTest.java
Wed Feb 6 12:12:59 2013
@@ -32,7 +32,7 @@ import static org.junit.Assert.*;
/**
* Tests the {@link DerivedMap}. For the purpose of this test, this class
implements an
* {@link ObjectConverter} for which input values are multiplied by 100,
except value
- * {@value #EXCLUDED} which is converted to {@code null} (meaning: excluded
from the
+ * {@code EXCLUDED} which is converted to {@code null} (meaning: excluded from
the
* converted map).
*
* @author Martin Desruisseaux (Geomatys)
Modified:
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/iso/AbstractNameTest.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/iso/AbstractNameTest.java?rev=1442921&r1=1442920&r2=1442921&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/iso/AbstractNameTest.java
(original)
+++
sis/branches/JDK7/sis-utility/src/test/java/org/apache/sis/util/iso/AbstractNameTest.java
Wed Feb 6 12:12:59 2013
@@ -29,7 +29,7 @@ import static org.apache.sis.util.iso.De
/**
* Tests the {@link DefaultLocalName} and {@link DefaultScopedName}
implementations.
* This test suite instantiate the objects directly, without using {@link
DefaultNameFactory}.
- * For tests using the name factory, see {@link NameFactoryTest}.
+ * For tests using the name factory, see {@link DefaultNameFactoryTest}.
*
* @author Martin Desruisseaux (Geomatys)
* @since 0.3 (derived from goetk-3.00)
