sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1768094 - in /sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis: geometry/Envelopes.java referencing/operation/AbstractSingleOperation.java referencing/operation/DefaultTransformation.java
Date Fri, 04 Nov 2016 20:56:46 GMT
Author: desruisseaux
Date: Fri Nov  4 20:56:46 2016
New Revision: 1768094

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

Modified:
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractSingleOperation.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultTransformation.java

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java?rev=1768094&r1=1768093&r2=1768094&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
[UTF-8] Fri Nov  4 20:56:46 2016
@@ -119,14 +119,14 @@ public final class Envelopes extends Sta
      * A buckle method for calculating derivative and coordinate transformation in a single
step,
      * if the given {@code derivative} argument is {@code true}.
      *
-     * @param transform The transform to use.
-     * @param srcPts    The array containing the source coordinate at offset 0.
-     * @param dstPts    the array into which the transformed coordinate is returned.
-     * @param dstOff    The offset to the location of the transformed point that is stored
in the destination array.
-     * @param derivate  {@code true} for computing the derivative, or {@code false} if not
needed.
-     * @return The matrix of the transform derivative at the given source position,
+     * @param  transform  the transform to use.
+     * @param  srcPts     the array containing the source coordinate at offset 0.
+     * @param  dstPts     the array into which the transformed coordinate is returned.
+     * @param  dstOff     the offset to the location of the transformed point that is stored
in the destination array.
+     * @param  derivate   {@code true} for computing the derivative, or {@code false} if
not needed.
+     * @return the matrix of the transform derivative at the given source position,
      *         or {@code null} if the {@code derivate} argument is {@code false}.
-     * @throws TransformException If the point can not be transformed
+     * @throws TransformException if the point can not be transformed
      *         or if a problem occurred while calculating the derivative.
      */
     static Matrix derivativeAndTransform(final MathTransform transform, final double[] srcPts,
@@ -152,10 +152,10 @@ public final class Envelopes extends Sta
      * to get the {@link CoordinateOperation} or {@link MathTransform} instance once and
invoke one of the
      * others {@code transform(…)} methods.
      *
-     * @param  envelope The envelope to transform (may be {@code null}).
-     * @param  targetCRS The target CRS (may be {@code null}).
-     * @return A new transformed envelope, or directly {@code envelope} if no change was
required.
-     * @throws TransformException If a transformation was required and failed.
+     * @param  envelope   the envelope to transform (may be {@code null}).
+     * @param  targetCRS  the target CRS (may be {@code null}).
+     * @return a new transformed envelope, or directly {@code envelope} if no change was
required.
+     * @throws TransformException if a transformation was required and failed.
      *
      * @since 0.5
      */
@@ -194,9 +194,9 @@ public final class Envelopes extends Sta
      * or when it crosses the ±180° longitude, because {@link MathTransform} does not carry
sufficient information.
      * For a more robust envelope transformation, use {@link #transform(CoordinateOperation,
Envelope)} instead.
      *
-     * @param  transform The transform to use.
-     * @param  envelope Envelope to transform, or {@code null}. This envelope will not be
modified.
-     * @return The transformed envelope, or {@code null} if {@code envelope} was null.
+     * @param  transform  the transform to use.
+     * @param  envelope   envelope to transform, or {@code null}. This envelope will not
be modified.
+     * @return the transformed envelope, or {@code null} if {@code envelope} was null.
      * @throws TransformException if a transform failed.
      *
      * @see #transform(CoordinateOperation, Envelope)
@@ -214,9 +214,9 @@ public final class Envelopes extends Sta
      * Implementation of {@link #transform(MathTransform, Envelope)} with the opportunity
to
      * save the projected center coordinate.
      *
-     * @param targetPt After this method call, the center of the source envelope projected
to
-     *        the target CRS. The length of this array must be the number of target dimensions.
-     *        May be {@code null} if this information is not needed.
+     * @param  targetPt  after this method call, the center of the source envelope projected
to the target CRS.
+     *                   The length of this array must be the number of target dimensions.
+     *                   May be {@code null} if this information is not needed.
      */
     @SuppressWarnings("null")
     private static GeneralEnvelope transform(final MathTransform transform,
@@ -426,9 +426,9 @@ public final class Envelopes extends Sta
      * of accuracy. In order to prevent this method from performing such pre-transformation
(if not desired),
      * callers can ensure that the envelope CRS is {@code null} before to call this method.</div>
      *
-     * @param  operation The operation to use.
-     * @param  envelope Envelope to transform, or {@code null}. This envelope will not be
modified.
-     * @return The transformed envelope, or {@code null} if {@code envelope} was null.
+     * @param  operation  the operation to use.
+     * @param  envelope   envelope to transform, or {@code null}. This envelope will not
be modified.
+     * @return the transformed envelope, or {@code null} if {@code envelope} was null.
      * @throws TransformException if a transform failed.
      *
      * @see #transform(MathTransform, Envelope)
@@ -742,9 +742,9 @@ public final class Envelopes extends Sta
      * See {@link GeneralEnvelope#GeneralEnvelope(CharSequence)} for more information about
the
      * parsing rules.
      *
-     * @param  wkt The {@code BOX}, {@code POLYGON} or other kind of element to parse.
-     * @return The envelope of the given geometry.
-     * @throws FactoryException If the given WKT can not be parsed.
+     * @param  wkt  the {@code BOX}, {@code POLYGON} or other kind of element to parse.
+     * @return the envelope of the given geometry.
+     * @throws FactoryException if the given WKT can not be parsed.
      *
      * @see #toString(Envelope)
      * @see CRS#fromWKT(String)
@@ -775,8 +775,8 @@ public final class Envelopes extends Sta
      * The string returned by this method can be {@linkplain GeneralEnvelope#GeneralEnvelope(CharSequence)
      * parsed} by the {@code GeneralEnvelope} constructor.
      *
-     * @param  envelope The envelope to format.
-     * @return This envelope as a {@code BOX} or {@code BOX3D} (most typical dimensions)
element.
+     * @param  envelope  the envelope to format.
+     * @return this envelope as a {@code BOX} or {@code BOX3D} (most typical dimensions)
element.
      *
      * @see #fromWKT(CharSequence)
      * @see org.apache.sis.io.wkt
@@ -793,8 +793,8 @@ public final class Envelopes extends Sta
      * <p>The string returned by this method can be {@linkplain GeneralEnvelope#GeneralEnvelope(CharSequence)
      * parsed} by the {@code GeneralEnvelope} constructor.</p>
      *
-     * @param  envelope The envelope to format.
-     * @return The envelope as a {@code POLYGON} in WKT format.
+     * @param  envelope  the envelope to format.
+     * @return the envelope as a {@code POLYGON} in WKT format.
      * @throws IllegalArgumentException if the given envelope can not be formatted.
      *
      * @see org.apache.sis.io.wkt

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractSingleOperation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractSingleOperation.java?rev=1768094&r1=1768093&r2=1768094&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractSingleOperation.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractSingleOperation.java
[UTF-8] Fri Nov  4 20:56:46 2016
@@ -160,7 +160,7 @@ class AbstractSingleOperation extends Ab
      *
      * <p>This constructor performs a shallow copy, i.e. the properties are not cloned.</p>
      *
-     * @param operation The coordinate operation to copy.
+     * @param  operation  the coordinate operation to copy.
      */
     protected AbstractSingleOperation(final SingleOperation operation) {
         super(operation);
@@ -189,10 +189,10 @@ class AbstractSingleOperation extends Ab
      *       is taken. Only one non-ignorable step may exist, otherwise we do not try to
select any of them.</li>
      * </ul>
      *
-     * @param  method     The operation method to compare to the math transform.
-     * @param  interpDim  The number of interpolation dimension, or 0 if none.
-     * @param  transform  The math transform to compare to the operation method.
-     * @param  properties Properties of the caller object being constructed, used only for
formatting error message.
+     * @param  method      the operation method to compare to the math transform.
+     * @param  interpDim   the number of interpolation dimension, or 0 if none.
+     * @param  transform   the math transform to compare to the operation method.
+     * @param  properties  properties of the caller object being constructed, used only for
formatting error message.
      * @throws IllegalArgumentException if the number of dimensions are incompatible.
      */
     static void checkDimensions(final OperationMethod method, final int interpDim, MathTransform
transform,
@@ -277,7 +277,7 @@ class AbstractSingleOperation extends Ab
      * Returns a description of the operation method, including a list of expected parameter
names.
      * The returned object does not contains any parameter value.
      *
-     * @return A description of the operation method.
+     * @return a description of the operation method.
      */
     @Override
     @XmlElement(name = "method", required = true)
@@ -301,7 +301,7 @@ class AbstractSingleOperation extends Ab
      * should be very similar. If they differ, it should be only in minor details like remarks,
default
      * values or units of measurement.</div>
      *
-     * @return A description of the parameters.
+     * @return a description of the parameters.
      *
      * @see DefaultOperationMethod#getParameters()
      * @see org.apache.sis.referencing.operation.transform.AbstractMathTransform#getParameterDescriptors()
@@ -322,7 +322,7 @@ class AbstractSingleOperation extends Ab
      *   <li>Otherwise throw {@link org.apache.sis.util.UnsupportedImplementationException}.</li>
      * </ul>
      *
-     * @return The parameter values.
+     * @return the parameter values.
      * @throws UnsupportedOperationException if the parameter values can not be determined
      *         for the current math transform implementation.
      *
@@ -344,7 +344,7 @@ class AbstractSingleOperation extends Ab
     @Override
     public boolean equals(final Object object, final ComparisonMode mode) {
         if (object == this) {
-            return true;   // Slight optimization.
+            return true;                            // Slight optimization.
         }
         if (!super.equals(object, mode)) {
             return false;

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultTransformation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultTransformation.java?rev=1768094&r1=1768093&r2=1768094&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultTransformation.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultTransformation.java
[UTF-8] Fri Nov  4 20:56:46 2016
@@ -97,12 +97,12 @@ public class DefaultTransformation exten
      *   </tr>
      * </table>
      *
-     * @param properties The properties to be given to the identified object.
-     * @param sourceCRS  The source CRS.
-     * @param targetCRS  The target CRS.
-     * @param interpolationCRS The CRS of additional coordinates needed for the operation,
or {@code null} if none.
-     * @param method     The coordinate operation method (mandatory in all cases).
-     * @param transform  Transform from positions in the source CRS to positions in the target
CRS.
+     * @param  properties        the properties to be given to the identified object.
+     * @param  sourceCRS         the source CRS.
+     * @param  targetCRS         the target CRS.
+     * @param  interpolationCRS  the CRS of additional coordinates needed for the operation,
or {@code null} if none.
+     * @param  method            the coordinate operation method (mandatory in all cases).
+     * @param  transform         transform from positions in the source CRS to positions
in the target CRS.
      */
     public DefaultTransformation(final Map<String,?>             properties,
                                  final CoordinateReferenceSystem sourceCRS,
@@ -123,7 +123,7 @@ public class DefaultTransformation exten
      *
      * <p>This constructor performs a shallow copy, i.e. the properties are not cloned.</p>
      *
-     * @param operation The coordinate operation to copy.
+     * @param  operation  the coordinate operation to copy.
      *
      * @see #castOrCopy(Transformation)
      */
@@ -139,8 +139,8 @@ public class DefaultTransformation exten
      * Note that this is a <cite>shallow</cite> copy operation, since the other
properties contained in the given
      * object are not recursively copied.
      *
-     * @param  object The object to get as a SIS implementation, or {@code null} if none.
-     * @return A SIS implementation containing the values of the given object (may be the
+     * @param  object  the object to get as a SIS implementation, or {@code null} if none.
+     * @return a SIS implementation containing the values of the given object (may be the
      *         given object itself), or {@code null} if the argument was null.
      */
     public static DefaultTransformation castOrCopy(final Transformation object) {



Mime
View raw message