Author: desruisseaux
Date: Sun Mar 16 17:31:12 2014
New Revision: 1578119
URL: http://svn.apache.org/r1578119
Log:
Minor javadoc fixes.
Modified:
sis/branches/JDK7/core/sis-feature/src/main/java/org/apache/sis/feature/AbstractIdentifiedType.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Colors.java
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/FormattableObject.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptorGroup.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValueGroup.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterBuilder.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterFormat.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java
sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/parameter/DefaultParameterDescriptorGroupTest.java
sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/parameter/DefaultParameterValueGroupTest.java
Modified:
sis/branches/JDK7/core/sis-feature/src/main/java/org/apache/sis/feature/AbstractIdentifiedType.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-feature/src/main/java/org/apache/sis/feature/AbstractIdentifiedType.java?rev=1578119&r1=1578118&r2=1578119&view=diff
==============================================================================
---
sis/branches/JDK7/core/sis-feature/src/main/java/org/apache/sis/feature/AbstractIdentifiedType.java
[UTF-8] (original)
+++
sis/branches/JDK7/core/sis-feature/src/main/java/org/apache/sis/feature/AbstractIdentifiedType.java
[UTF-8] Sun Mar 16 17:31:12 2014
@@ -17,6 +17,7 @@
package org.apache.sis.feature;
import java.util.Map;
+import java.util.Locale;
import java.io.Serializable;
import org.opengis.util.GenericName;
import org.opengis.util.InternationalString;
Modified:
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Colors.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Colors.java?rev=1578119&r1=1578118&r2=1578119&view=diff
==============================================================================
---
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Colors.java
[UTF-8] (original)
+++
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Colors.java
[UTF-8] Sun Mar 16 17:31:12 2014
@@ -49,11 +49,11 @@ public class Colors implements Cloneable
private static final long serialVersionUID = 256160285861027191L;
/**
- * The default colors used by {@link FormattableObject#print(Convention)}.
+ * The default colors used by {@link FormattableObject#print()}.
* Those colors give better results on a {@link java.io.Console} with
black background.
* This map is immutable.
*
- * @see FormattableObject#print(Convention)
+ * @see FormattableObject#print()
*/
public static final Colors DEFAULT = new Colors();
static {
Modified:
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/FormattableObject.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/FormattableObject.java?rev=1578119&r1=1578118&r2=1578119&view=diff
==============================================================================
---
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/FormattableObject.java
[UTF-8] (original)
+++
sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/FormattableObject.java
[UTF-8] Sun Mar 16 17:31:12 2014
@@ -43,7 +43,7 @@ import org.apache.sis.internal.util.X364
* </ul>
*
* {@section Syntax coloring}
- * A convenience {@link #print(Convention)} method is provided, which is
roughly equivalent to
+ * A convenience {@link #print()} method is provided, which is roughly
equivalent to
* {@code System.out.println(this)} except that syntax coloring is
automatically applied
* if the terminal seems to support the ANSI escape codes.
*
@@ -54,7 +54,7 @@ import org.apache.sis.internal.util.X364
* <ul>
* <li>{@link #toWKT()} will throw a {@link
UnformattableObjectException}.</li>
* <li>{@link #toString()} will ignore the problem and uses non-standard
elements if needed.</li>
- * <li>{@link #print(Convention)} will show the non-standard elements in red
if syntax coloring is enabled.</li>
+ * <li>{@link #print()} will show the non-standard elements in red if syntax
coloring is enabled.</li>
* </ul>
*
* @author Martin Desruisseaux (IRD, Geomatys)
Modified:
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptorGroup.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptorGroup.java?rev=1578119&r1=1578118&r2=1578119&view=diff
==============================================================================
---
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptorGroup.java
[UTF-8] (original)
+++
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptorGroup.java
[UTF-8] Sun Mar 16 17:31:12 2014
@@ -265,9 +265,10 @@ public class DefaultParameterDescriptorG
* Returns the GeoAPI interface implemented by this class.
* The SIS implementation returns {@code ParameterDescriptorGroup.class}.
*
- * {@note Subclasses usually do not need to override this method since
GeoAPI does not define
- * <code>ParameterDescriptorGroup</code> sub-interface. Overriding
possibility is left mostly
- * for implementors who wish to extend GeoAPI with their own set of
interfaces.}
+ * <div class="note"><b>Note for implementors:</b>
+ * Subclasses usually do not need to override this method since GeoAPI
does not define {@code ParameterDescriptorGroup}
+ * sub-interface. Overriding possibility is left mostly for implementors
who wish to extend GeoAPI with their own
+ * set of interfaces.</div>
*
* @return {@code ParameterDescriptorGroup.class} or a user-defined
sub-interface.
*/
Modified:
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValueGroup.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValueGroup.java?rev=1578119&r1=1578118&r2=1578119&view=diff
==============================================================================
---
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValueGroup.java
[UTF-8] (original)
+++
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValueGroup.java
[UTF-8] Sun Mar 16 17:31:12 2014
@@ -181,8 +181,6 @@ public class DefaultParameterValueGroup
* @param name The name of the parameter to search for.
* @return The parameter value for the given name.
* @throws ParameterNotFoundException if there is no parameter value for
the given name.
- *
- * @see Parameters#getOrCreate(ParameterDescriptor, ParameterValueGroup)
*/
@Override
public ParameterValue<?> parameter(final String name) throws
ParameterNotFoundException {
Modified:
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterBuilder.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterBuilder.java?rev=1578119&r1=1578118&r2=1578119&view=diff
==============================================================================
---
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterBuilder.java
[UTF-8] (original)
+++
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterBuilder.java
[UTF-8] Sun Mar 16 17:31:12 2014
@@ -252,12 +252,12 @@ public class ParameterBuilder extends Bu
* The descriptor has no minimal or maximal value and no unit.
*
* <p>The {@code validValues} property is mostly for restricting values to
- * a {@linkplain org.opengis.util.CodeList code list} or enumeration
subset.
+ * a {@linkplain org.opengis.util.CodeList code list} or {@linkplain Enum
enumeration} subset.
* It is not necessary to provide this property when all values from the
code list or enumeration are valid.</p>
*
* @param <T> The compile-time type of the {@code valueClass}
argument.
* @param valueClass The class that describe the type of the parameter
values.
- * @param validValues A finite set of valid values (usually from a
{@linkplain CodeList code list})
+ * @param validValues A finite set of valid values (usually from a code
list or enumeration)
* or {@code null} if it doesn't apply.
* @param defaultValue The default value for the parameter, or {@code
null} if none.
* @return The parameter descriptor for the given set of valid values.
@@ -290,7 +290,8 @@ public class ParameterBuilder extends Bu
* {@link #createGroup(int, int, GeneralParameterDescriptor[])} with a
cardinality of [0 … 1]
* or [1 … 1] depending on the value given to the last call to {@link
#setRequired(boolean)}.
*
- * @param parameters The {@linkplain #descriptors() parameter
descriptors} for the group to create.
+ * @param parameters The {@linkplain
DefaultParameterDescriptorGroup#descriptors() parameter descriptors}
+ * for the group to create.
* @return The parameter descriptor group.
*/
public ParameterDescriptorGroup createGroup(final
GeneralParameterDescriptor... parameters) {
@@ -304,7 +305,8 @@ public class ParameterBuilder extends Bu
* number of times that values for this parameter
group are required.
* @param maximumOccurs The {@linkplain
DefaultParameterDescriptorGroup#getMaximumOccurs() maximum}
* number of times that values for this parameter
group are required.
- * @param parameters The {@linkplain #descriptors() parameter
descriptors} for the group to create.
+ * @param parameters The {@linkplain
DefaultParameterDescriptorGroup#descriptors() parameter descriptors}
+ * for the group to create.
* @return The parameter descriptor group.
*/
public ParameterDescriptorGroup createGroup(final int minimumOccurs, final
int maximumOccurs,
Modified:
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterFormat.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterFormat.java?rev=1578119&r1=1578118&r2=1578119&view=diff
==============================================================================
---
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterFormat.java
[UTF-8] (original)
+++
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterFormat.java
[UTF-8] Sun Mar 16 17:31:12 2014
@@ -80,8 +80,8 @@ import static org.apache.sis.util.collec
* │ Latitude of natural origin │ Double │ Mandatory │ [-80 … 84]° │
0.0° │
* │ Longitude of natural origin │ Double │ Mandatory │ [-180 … 180]° │
0.0° │
* │ Scale factor at natural origin │ Double │ Mandatory │ (0 … ∞) │
1.0 │
- * │ False easting │ Double │ Optional │ (-∞ … ∞) m │
0.0 m │
- * │ False northing │ Double │ Optional │ (-∞ … ∞) m │
0.0 m │
+ * │ False easting │ Double │ Mandatory │ (-∞ … ∞) m │
0.0 m │
+ * │ False northing │ Double │ Mandatory │ (-∞ … ∞) m │
0.0 m │
*
└────────────────────────────────┴────────┴────────────┴───────────────┴───────────────┘
* }
* </div>
@@ -159,10 +159,10 @@ public class ParameterFormat extends Tab
* ║ EPSG: Scale factor at natural origin │ Double │ Mandatory │
(0 … ∞) │ 1.0 ║
* ║ OGC: scale_factor │ │ │
│ ║
*
╟──────────────────────────────────────┼────────┼────────────┼───────────────┼───────────────╢
- * ║ EPSG: False easting │ Double │ Optional │
(-∞ … ∞) m │ 0.0 m ║
+ * ║ EPSG: False easting │ Double │ Mandatory │
(-∞ … ∞) m │ 0.0 m ║
* ║ OGC: false_easting │ │ │
│ ║
*
╟──────────────────────────────────────┼────────┼────────────┼───────────────┼───────────────╢
- * ║ EPSG: False northing │ Double │ Optional │
(-∞ … ∞) m │ 0.0 m ║
+ * ║ EPSG: False northing │ Double │ Mandatory │
(-∞ … ∞) m │ 0.0 m ║
* ║ OGC: false_northing │ │ │
│ ║
*
╚══════════════════════════════════════╧════════╧════════════╧═══════════════╧═══════════════╝
* }
@@ -188,8 +188,8 @@ public class ParameterFormat extends Tab
* │ Latitude of natural origin │ Double │ Mandatory │ [-80 …
84]° │ 0.0° │
* │ Longitude of natural origin │ Double │ Mandatory │ [-180 …
180]° │ 0.0° │
* │ Scale factor at natural origin │ Double │ Mandatory │ (0 …
∞) │ 1.0 │
- * │ False easting │ Double │ Optional │ (-∞ …
∞) m │ 0.0 m │
- * │ False northing │ Double │ Optional │ (-∞ …
∞) m │ 0.0 m │
+ * │ False easting │ Double │ Mandatory │ (-∞ …
∞) m │ 0.0 m │
+ * │ False northing │ Double │ Mandatory │ (-∞ …
∞) m │ 0.0 m │
*
└────────────────────────────────┴────────┴────────────┴───────────────┴───────────────┘
* }
* </div>
@@ -202,7 +202,7 @@ public class ParameterFormat extends Tab
* The summary contains the identifier names and aliases aligned in a
table.
*
* <div class="note"><b>Example:</b>
- * The <cite>Mercator (variant A)</cite> example given in {@link
ParameterBuiler} javadoc
+ * The <cite>Mercator (variant A)</cite> example given in {@link
ParameterBuilder} javadoc
* formatted at this level produces a text like below:
*
* {@preformat text
Modified:
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java?rev=1578119&r1=1578118&r2=1578119&view=diff
==============================================================================
---
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java
[UTF-8] (original)
+++
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java
[UTF-8] Sun Mar 16 17:31:12 2014
@@ -48,7 +48,7 @@ import java.util.Objects;
/**
- * Creates parameter groups from tensors (usually matrices), and conversely.
+ * Creates parameter groups for tensors (usually matrices).
* Matrices are handled as a special case of tensors
(<cite>second-order</cite> tensors).
*
* <p>Each group of parameters contains the following elements:</p>
Modified:
sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/parameter/DefaultParameterDescriptorGroupTest.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/parameter/DefaultParameterDescriptorGroupTest.java?rev=1578119&r1=1578118&r2=1578119&view=diff
==============================================================================
---
sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/parameter/DefaultParameterDescriptorGroupTest.java
[UTF-8] (original)
+++
sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/parameter/DefaultParameterDescriptorGroupTest.java
[UTF-8] Sun Mar 16 17:31:12 2014
@@ -91,7 +91,7 @@ public final strictfp class DefaultParam
}
/**
- * Validates the test parameter descriptors created by {@link
#createGroup_2M_2O()}.
+ * Validates the test parameter descriptors given by {@link #M1_M1_O1_O2}.
*/
@Test
public void validateTestObjects() {
Modified:
sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/parameter/DefaultParameterValueGroupTest.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/parameter/DefaultParameterValueGroupTest.java?rev=1578119&r1=1578118&r2=1578119&view=diff
==============================================================================
---
sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/parameter/DefaultParameterValueGroupTest.java
[UTF-8] (original)
+++
sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/parameter/DefaultParameterValueGroupTest.java
[UTF-8] Sun Mar 16 17:31:12 2014
@@ -91,7 +91,7 @@ public final strictfp class DefaultParam
}
/**
- * Validates the test parameter values created by {@link
#createValues(List, int)}.
+ * Validates the test parameter values created by {@link
#createValues(int)}.
*/
@Test
public void validateTestObjects() {
