sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1753235 - in /sis/branches/JDK8/core/sis-referencing/src: main/java/org/apache/sis/parameter/ParameterBuilder.java test/java/org/apache/sis/referencing/operation/projection/MercatorTest.java
Date Mon, 18 Jul 2016 14:56:28 GMT
Author: desruisseaux
Date: Mon Jul 18 14:56:28 2016
New Revision: 1753235

URL: http://svn.apache.org/viewvc?rev=1753235&view=rev
Log:
Javadoc formatting.

Modified:
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterBuilder.java
    sis/branches/JDK8/core/sis-referencing/src/test/java/org/apache/sis/referencing/operation/projection/MercatorTest.java

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterBuilder.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterBuilder.java?rev=1753235&r1=1753234&r2=1753235&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterBuilder.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterBuilder.java
[UTF-8] Mon Jul 18 14:56:28 2016
@@ -125,7 +125,7 @@ public class ParameterBuilder extends Bu
     /**
      * Creates a new builder initialized to properties of the given object.
      *
-     * @param descriptor The descriptor from which to inherit properties, or {@code null}.
+     * @param descriptor  the descriptor from which to inherit properties, or {@code null}.
      *
      * @since 0.6
      */
@@ -165,10 +165,10 @@ public class ParameterBuilder extends Bu
     /**
      * Creates a descriptor for values of the given type without domain restriction.
      *
-     * @param  <T>          The compile-time type of the {@code valueClass} argument.
-     * @param  valueClass   The class that describe the type of the parameter values.
-     * @param  defaultValue The default value for the parameter, or {@code null} if none.
-     * @return The parameter descriptor for the given default value and unit.
+     * @param  <T>           the compile-time type of the {@code valueClass} argument.
+     * @param  valueClass    the class that describe the type of the parameter values.
+     * @param  defaultValue  the default value for the parameter, or {@code null} if none.
+     * @return the parameter descriptor for the given default value and unit.
      */
     public <T> ParameterDescriptor<T> create(final Class<T> valueClass,
final T defaultValue) {
         return create(valueClass, null, null, defaultValue);
@@ -178,9 +178,9 @@ public class ParameterBuilder extends Bu
      * Creates a descriptor for floating point values without domain restriction.
      * All {@code double} values are considered valid.
      *
-     * @param  defaultValue The default value for the parameter, or {@link Double#NaN} if
none.
-     * @param  unit         The default unit, or {@code null} if none.
-     * @return The parameter descriptor for the given default value and unit.
+     * @param  defaultValue  the default value for the parameter, or {@link Double#NaN} if
none.
+     * @param  unit          the default unit, or {@code null} if none.
+     * @return the parameter descriptor for the given default value and unit.
      */
     public ParameterDescriptor<Double> create(final double defaultValue, final Unit<?>
unit) {
         final Range<Double> valueDomain;
@@ -196,9 +196,9 @@ public class ParameterBuilder extends Bu
      * Creates a descriptor for floating point values greater than zero.
      * The zero value is not considered valid. There is no maximal value.
      *
-     * @param  defaultValue The default value for the parameter, or {@link Double#NaN} if
none.
-     * @param  unit         The default unit, or {@code null} if none.
-     * @return The parameter descriptor for the given default value and unit.
+     * @param  defaultValue  the default value for the parameter, or {@link Double#NaN} if
none.
+     * @param  unit          the default unit, or {@code null} if none.
+     * @return the parameter descriptor for the given default value and unit.
      */
     public ParameterDescriptor<Double> createStrictlyPositive(final double defaultValue,
final Unit<?> unit) {
         final Range<Double> valueDomain;
@@ -213,11 +213,11 @@ public class ParameterBuilder extends Bu
     /**
      * Creates a descriptor for floating point values restricted to the given domain.
      *
-     * @param  minimumValue The minimum parameter value (inclusive), or {@link Double#NEGATIVE_INFINITY}
if none.
-     * @param  maximumValue The maximum parameter value (inclusive), or {@link Double#POSITIVE_INFINITY}
if none.
-     * @param  defaultValue The default value for the parameter, or {@link Double#NaN} if
none.
-     * @param  unit         The unit for default, minimum and maximum values, or {@code null}
if none.
-     * @return The parameter descriptor for the given domain of values.
+     * @param  minimumValue  the minimum parameter value (inclusive), or {@link Double#NEGATIVE_INFINITY}
if none.
+     * @param  maximumValue  the maximum parameter value (inclusive), or {@link Double#POSITIVE_INFINITY}
if none.
+     * @param  defaultValue  the default value for the parameter, or {@link Double#NaN} if
none.
+     * @param  unit          the unit for default, minimum and maximum values, or {@code
null} if none.
+     * @return the parameter descriptor for the given domain of values.
      */
     public ParameterDescriptor<Double> createBounded(final double minimumValue, final
double maximumValue,
             final double defaultValue, final Unit<?> unit)
@@ -236,10 +236,10 @@ public class ParameterBuilder extends Bu
     /**
      * Creates a descriptor for integer values restricted to the given domain.
      *
-     * @param  minimumValue The minimum parameter value (inclusive).
-     * @param  maximumValue The maximum parameter value (inclusive).
-     * @param  defaultValue The default value for the parameter.
-     * @return The parameter descriptor for the given domain of values.
+     * @param  minimumValue  the minimum parameter value (inclusive).
+     * @param  maximumValue  the maximum parameter value (inclusive).
+     * @param  defaultValue  the default value for the parameter.
+     * @return the parameter descriptor for the given domain of values.
      */
     public ParameterDescriptor<Integer> createBounded(final int minimumValue, final
int maximumValue,
             final int defaultValue)
@@ -250,12 +250,12 @@ public class ParameterBuilder extends Bu
     /**
      * Creates a descriptor for values of the given type restricted to the given domain.
      *
-     * @param  <T>          The compile-time type of the {@code valueClass} argument.
-     * @param  valueClass   The class that describe the type of the parameter values.
-     * @param  minimumValue The minimum parameter value (inclusive), or {@code null} if none.
-     * @param  maximumValue The maximum parameter value (inclusive), or {@code null} if none.
-     * @param  defaultValue The default value for the parameter, or {@code null} if none.
-     * @return The parameter descriptor for the given domain of values.
+     * @param  <T>           the compile-time type of the {@code valueClass} argument.
+     * @param  valueClass    the class that describe the type of the parameter values.
+     * @param  minimumValue  the minimum parameter value (inclusive), or {@code null} if
none.
+     * @param  maximumValue  the maximum parameter value (inclusive), or {@code null} if
none.
+     * @param  defaultValue  the default value for the parameter, or {@code null} if none.
+     * @return the parameter descriptor for the given domain of values.
      */
     @SuppressWarnings({"unchecked", "rawtypes"})
     public <T extends Comparable<? super T>> ParameterDescriptor<T> createBounded(final
Class<T> valueClass,
@@ -277,10 +277,10 @@ public class ParameterBuilder extends Bu
      * Creates a descriptor for values in the domain represented by the given {@code Range}
object.
      * This method allows to specify whether the minimum and maximum values are inclusive
or not.
      *
-     * @param  <T>          The type of the parameter values.
-     * @param  valueDomain  The minimum value, maximum value and unit of measurement.
-     * @param  defaultValue The default value for the parameter, or {@code null} if none.
-     * @return The parameter descriptor for the given domain of values.
+     * @param  <T>           the type of the parameter values.
+     * @param  valueDomain   the minimum value, maximum value and unit of measurement.
+     * @param  defaultValue  the default value for the parameter, or {@code null} if none.
+     * @return the parameter descriptor for the given domain of values.
      */
     public <T extends Comparable<? super T>> ParameterDescriptor<T> createBounded(
             final Range<T> valueDomain, final T defaultValue)
@@ -297,12 +297,12 @@ public class ParameterBuilder extends Bu
      * 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 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.
+     * @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 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.
      */
     public <T> ParameterDescriptor<T> createEnumerated(final Class<T> valueClass,
final T[] validValues, final T defaultValue) {
         ensureNonNull("valueClass", valueClass);
@@ -330,13 +330,13 @@ public class ParameterBuilder extends Bu
     /**
      * Creates a descriptor group for the given cardinality and parameters.
      *
-     * @param  minimumOccurs The {@linkplain DefaultParameterDescriptorGroup#getMinimumOccurs()
minimum}
-     *                       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 DefaultParameterDescriptorGroup#descriptors()
parameter descriptors}
-     *                       for the group to create.
-     * @return The parameter descriptor group.
+     * @param  minimumOccurs  the {@linkplain DefaultParameterDescriptorGroup#getMinimumOccurs()
minimum}
+     *                        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 DefaultParameterDescriptorGroup#descriptors()
parameter descriptors}
+     *                        for the group to create.
+     * @return the parameter descriptor group.
      */
     public ParameterDescriptorGroup createGroup(final int minimumOccurs, final int maximumOccurs,
             final GeneralParameterDescriptor... parameters)
@@ -356,9 +356,9 @@ 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 DefaultParameterDescriptorGroup#descriptors() parameter
descriptors}
+     * @param  parameters  the {@linkplain DefaultParameterDescriptorGroup#descriptors()
parameter descriptors}
      *         for the group to create.
-     * @return The parameter descriptor group.
+     * @return the parameter descriptor group.
      */
     public ParameterDescriptorGroup createGroup(final GeneralParameterDescriptor... parameters)
{
         return createGroup(required ? 1 : 0, 1, parameters);
@@ -373,8 +373,8 @@ public class ParameterBuilder extends Bu
      * expect the same parameters than their <cite>"Position Vector transformation"</cite>
counterpart
      * (EPSG codes 1033, 1037 and 9606) but perform the rotation in the opposite direction.</div>
      *
-     * @param parameters The existing group from which to copy the parameters.
-     * @return The parameter descriptor group.
+     * @param  parameters  the existing group from which to copy the parameters.
+     * @return the parameter descriptor group.
      *
      * @since 0.7
      */
@@ -421,9 +421,9 @@ public class ParameterBuilder extends Bu
      * minimum} and {@linkplain DefaultParameterDescriptorGroup#getMaximumOccurs() maximum
occurrence} of 1,
      * regardless the value given to {@link #setRequired(boolean)}.
      *
-     * @param  parameters The {@linkplain DefaultParameterDescriptorGroup#descriptors() parameter
descriptors}
+     * @param  parameters the {@linkplain DefaultParameterDescriptorGroup#descriptors() parameter
descriptors}
      *         for the group to create.
-     * @return The parameter descriptor group for a map projection.
+     * @return the parameter descriptor group for a map projection.
      *
      * @since 0.6
      */

Modified: sis/branches/JDK8/core/sis-referencing/src/test/java/org/apache/sis/referencing/operation/projection/MercatorTest.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/test/java/org/apache/sis/referencing/operation/projection/MercatorTest.java?rev=1753235&r1=1753234&r2=1753235&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/test/java/org/apache/sis/referencing/operation/projection/MercatorTest.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/test/java/org/apache/sis/referencing/operation/projection/MercatorTest.java
[UTF-8] Mon Jul 18 14:56:28 2016
@@ -125,7 +125,7 @@ public final strictfp class MercatorTest
     /**
      * Tests the projection at some special latitudes (0, ±π/2, NaN).
      *
-     * @throws ProjectionException Should never happen.
+     * @throws ProjectionException if an error occurred while projecting a point.
      */
     @Test
     public void testSpecialLatitudes() throws ProjectionException {
@@ -155,7 +155,7 @@ public final strictfp class MercatorTest
      * Tests the derivatives at a few points. This method compares the derivatives computed
by
      * the projection with an estimation of derivatives computed by the finite differences
method.
      *
-     * @throws TransformException Should never happen.
+     * @throws TransformException if an error occurred while projecting a point.
      */
     @Test
     @DependsOnMethod("testSpecialLatitudes")



Mime
View raw message