Author: desruisseaux
Date: Tue Mar 18 20:06:46 2014
New Revision: 1579025
URL: http://svn.apache.org/r1579025
Log:
Minor javadoc.
Modified:
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/distance/DistanceUtils.java
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/package-info.java
sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/parameter/TensorParametersTest.java
Modified:
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/distance/DistanceUtils.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/distance/DistanceUtils.java?rev=1579025&r1=1579024&r2=1579025&view=diff
==============================================================================
---
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/distance/DistanceUtils.java
[UTF-8] (original)
+++
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/distance/DistanceUtils.java
[UTF-8] Tue Mar 18 20:06:46 2014
@@ -24,6 +24,9 @@ import org.apache.sis.geometry.DirectPos
* Class to calculate distances on earth surface. Actual calculation code very
* similar to Apache SIS but refractor to allow use of custom classes.
*
+ * <div class="warning">This class may change in a future SIS version. Current
implementation performs
+ * computations on a sphere of hard-coded radius. A future implementation
should perform computations
+ * on a given ellipsoid.</div>
*/
public class DistanceUtils {
Modified:
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/package-info.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/package-info.java?rev=1579025&r1=1579024&r2=1579025&view=diff
==============================================================================
---
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/package-info.java
[UTF-8] (original)
+++
sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/package-info.java
[UTF-8] Tue Mar 18 20:06:46 2014
@@ -22,27 +22,23 @@
*
* <p>Parameters are organized in <cite>groups</cite>. A group may be for
example the set of all parameters needed
* for the definition of a <cite>Mercator projection</cite>.
- * Parameter groups have some similarity with {@code java.util.Map} where:</p>
+ * Parameter groups have some similarities with {@code java.util.Map}
where:</p>
*
* <ul>
* <li>Keys are (indirectly) parameter
* {@linkplain
org.apache.sis.parameter.DefaultParameterDescriptor#getName() names}.</li>
- * <li>Values are typically (but not restricted to) {@code int}, {@code
int[]}, {@code double}, {@code double[]},
+ * <li>Values are (indirectly) typically of type {@code int}, {@code int[]},
{@code double}, {@code double[]},
* {@code boolean}, {@link java.lang.String}, {@link java.net.URI} or
- * {@link org.apache.sis.metadata.iso.citation.DefaultCitation Citation}
- * (note: there is a level of indirection through those values).</li>
- * <li>Each parameter (equivalent to map entry) defines its own set of
constraints on acceptable values:
- * <ul>
- * <li>The base {@linkplain
org.apache.sis.parameter.DefaultParameterDescriptor#getValueClass() value
class}.</li>
- * <li>Optionally the {@linkplain
org.apache.sis.parameter.DefaultParameterDescriptor#getValueDomain()
- * value domain} (i.e. minimum and maximum valid values) or an
enumeration of
- * {@linkplain
org.apache.sis.parameter.DefaultParameterDescriptor#getValidValues() valid
values}.</li>
- * </ul>
- * </li>
- * <li>Each entry can have a
- * {@linkplain
org.apache.sis.parameter.DefaultParameterDescriptor#getDefaultValue() default
value} and an
+ * {@link org.apache.sis.metadata.iso.citation.DefaultCitation
Citation}.</li>
+ * <li>Each parameter (equivalent to map entry) constraints the values to a
base
+ * {@linkplain
org.apache.sis.parameter.DefaultParameterDescriptor#getValueClass() value
class},
+ * and optionally to a {@linkplain
org.apache.sis.parameter.DefaultParameterDescriptor#getValueDomain()
+ * value domain} (i.e. minimum and maximum valid values) or an
enumeration of
+ * {@linkplain
org.apache.sis.parameter.DefaultParameterDescriptor#getValidValues() valid
values}.</li>
+ * <li>Each parameter can have a
+ * {@linkplain
org.apache.sis.parameter.DefaultParameterDescriptor#getDefaultValue() default
value} and a
* {@linkplain org.apache.sis.parameter.DefaultParameterValue#getUnit()
unit of measurement}.</li>
- * <li>Some parameters are mandatory ({@link
org.apache.sis.parameter.DefaultParameterDescriptor#getMinimumOccurs()
+ * <li>Some parameters are mandatory ({@linkplain
org.apache.sis.parameter.DefaultParameterDescriptor#getMinimumOccurs()
* minimum occurrence} = 1), meaning that they can not be removed from
the group.
* They can be left to their default value however.</li>
* <li>Group may contain other groups.</li>
Modified:
sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/parameter/TensorParametersTest.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/parameter/TensorParametersTest.java?rev=1579025&r1=1579024&r2=1579025&view=diff
==============================================================================
---
sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/parameter/TensorParametersTest.java
[UTF-8] (original)
+++
sis/branches/JDK7/core/sis-referencing/src/test/java/org/apache/sis/parameter/TensorParametersTest.java
[UTF-8] Tue Mar 18 20:06:46 2014
@@ -58,7 +58,7 @@ public final strictfp class TensorParame
}
/**
- * Tests {@link TensorParameters#getDimensionDescriptor(int[])}.
+ * Tests {@link TensorParameters#getDimensionDescriptor(int)}.
*/
@Test
public void testGetDimensionDescriptor() {
