This is an automated email from the ASF dual-hosted git repository.
desruisseaux pushed a commit to branch geoapi-4.0
in repository https://gitbox.apache.org/repos/asf/sis.git
commit b88fe42b92649f9985291fe068f7293b6ba051d2
Author: Martin Desruisseaux <martin.desruisse...@geomatys.com>
AuthorDate: Sat Jul 1 15:22:20 2023 +0200
Fix typos in documentation. No code change.
---
.../org/apache/sis/coverage/grid/DimensionalityReduction.java | 10 +++++-----
.../org/apache/sis/coverage/grid/GridCoverageProcessor.java | 4 ++--
.../src/main/java/org/apache/sis/coverage/grid/GridExtent.java | 2 +-
.../main/java/org/apache/sis/feature/ExpressionOperation.java | 2 +-
.../src/main/java/org/apache/sis/filter/ConvertFunction.java | 2 +-
.../src/main/java/org/apache/sis/image/ImageProcessor.java | 4 ++--
.../org/apache/sis/internal/coverage/j2d/ObservableImage.java | 2 +-
.../src/main/java/org/apache/sis/xml/MarshalContext.java | 2 +-
.../src/main/java/org/apache/sis/portrayal/MapLayers.java | 6 +++---
.../src/main/java/org/apache/sis/style/se1/Rule.java | 4 ++--
.../src/main/java/org/apache/sis/style/se1/StyleElement.java | 2 +-
.../src/main/java/org/apache/sis/style/se1/Symbolizer.java | 2 ++
.../src/test/java/org/apache/sis/style/se1/StyleTestCase.java | 2 +-
.../org/apache/sis/referencing/datum/BursaWolfParameters.java | 2 +-
.../org/apache/sis/referencing/datum/TimeDependentBWP.java | 2 +-
.../org/apache/sis/storage/geotiff/ImageMetadataBuilder.java | 2 +-
16 files changed, 26 insertions(+), 24 deletions(-)
diff --git
a/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/DimensionalityReduction.java
b/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/DimensionalityReduction.java
index 517edb4390..99ee46e398 100644
---
a/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/DimensionalityReduction.java
+++
b/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/DimensionalityReduction.java
@@ -172,7 +172,7 @@ public class DimensionalityReduction implements
UnaryOperator<GridCoverage>, Ser
* @param gridAxes bitmask of indices of source grid dimensions to keep
in the reduced grid.
* Will be modified by this constructor for internal
purpose.
* @param factory the factory to use for creating new math transforms,
or {@code null} if none.
- * @throws FactoryException if the dimensions to kept cannot be separated
from the dimensions to omit.
+ * @throws FactoryException if the dimensions to keep cannot be separated
from the dimensions to omit.
*/
protected DimensionalityReduction(final GridGeometry source, final BitSet
gridAxes, final MathTransformFactory factory)
throws FactoryException
@@ -318,7 +318,7 @@ public class DimensionalityReduction implements
UnaryOperator<GridCoverage>, Ser
* @param gridAxesToPass the grid axes to retain, ignoring order and
duplicated values.
* @return reduced grid geometry together with other information.
* @throws IndexOutOfBoundsException if a grid axis index is out of bounds.
- * @throws IllegalGridGeometryException if the dimensions to kept cannot
be separated from the dimensions to omit.
+ * @throws IllegalGridGeometryException if the dimensions to keep cannot
be separated from the dimensions to omit.
*/
public static DimensionalityReduction select(final GridGeometry source,
final int... gridAxesToPass) {
ArgumentChecks.ensureNonNull("source", source);
@@ -342,7 +342,7 @@ public class DimensionalityReduction implements
UnaryOperator<GridCoverage>, Ser
* @param source the grid geometry to reduce.
* @return reduced grid geometry together with other information.
* @throws IndexOutOfBoundsException if the grid geometry does not have at
least two dimensions.
- * @throws IllegalGridGeometryException if the dimensions to kept cannot
be separated from the dimensions to omit.
+ * @throws IllegalGridGeometryException if the dimensions to keep cannot
be separated from the dimensions to omit.
*
* @see org.apache.sis.storage.CoverageQuery#setAxisSelection(Function)
*/
@@ -359,7 +359,7 @@ public class DimensionalityReduction implements
UnaryOperator<GridCoverage>, Ser
* @param gridAxesToRemove the grid axes to remove, ignoring order and
duplicated values.
* @return reduced grid geometry together with other information.
* @throws IndexOutOfBoundsException if a grid axis index is out of bounds.
- * @throws IllegalGridGeometryException if the dimensions to kept cannot
be separated from the dimensions to omit.
+ * @throws IllegalGridGeometryException if the dimensions to keep cannot
be separated from the dimensions to omit.
*/
public static DimensionalityReduction remove(final GridGeometry source,
final int... gridAxesToRemove) {
ArgumentChecks.ensureNonNull("source", source);
@@ -380,7 +380,7 @@ public class DimensionalityReduction implements
UnaryOperator<GridCoverage>, Ser
* @param source the grid geometry to reduce.
* @return reduced grid geometry together with other information.
* @throws IncompleteGridGeometryException if the grid geometry has no
extent.
- * @throws IllegalGridGeometryException if the dimensions to kept cannot
be separated from the dimensions to omit.
+ * @throws IllegalGridGeometryException if the dimensions to keep cannot
be separated from the dimensions to omit.
*
* @see #select2D(GridGeometry)
*/
diff --git
a/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/GridCoverageProcessor.java
b/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/GridCoverageProcessor.java
index a708489344..897c4598c5 100644
---
a/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/GridCoverageProcessor.java
+++
b/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/GridCoverageProcessor.java
@@ -651,7 +651,7 @@ public class GridCoverageProcessor implements Cloneable {
* @return the reduced grid coverage, or {@code source} if no grid
dimensions was specified.
* @throws IndexOutOfBoundsException if a grid axis index is out of bounds.
* @throws SubspaceNotSpecifiedException if at least one removed dimension
has a grid extent size larger than 1 cell.
- * @throws IllegalGridGeometryException if the dimensions to kept cannot
be separated from the dimensions to omit.
+ * @throws IllegalGridGeometryException if the dimensions to keep cannot
be separated from the dimensions to omit.
*
* @see DimensionalityReduction#remove(GridGeometry, int...)
*
@@ -702,7 +702,7 @@ public class GridCoverageProcessor implements Cloneable {
* @return the reduced grid coverage, or {@code source} if all grid
dimensions where specified.
* @throws IndexOutOfBoundsException if a grid axis index is out of bounds.
* @throws SubspaceNotSpecifiedException if at least one removed dimension
has a grid extent size larger than 1 cell.
- * @throws IllegalGridGeometryException if the dimensions to kept cannot
be separated from the dimensions to omit.
+ * @throws IllegalGridGeometryException if the dimensions to keep cannot
be separated from the dimensions to omit.
*
* @see DimensionalityReduction#select(GridGeometry, int...)
*
diff --git
a/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/GridExtent.java
b/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/GridExtent.java
index 88d2370a8b..9f2d3abf6e 100644
---
a/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/GridExtent.java
+++
b/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/GridExtent.java
@@ -1004,7 +1004,7 @@ public class GridExtent implements GridEnvelope,
LenientComparable, Serializable
* Ensures that 0 ≤ {@code numDim} ≤ <var>n</var>
* where <var>n</var> is the number of dimensions of this grid extent.
*
- * @param numDim the user-supplied number of dimensions to validate.
+ * @param numDim the user supplied number of dimensions to validate.
* @return the number of dimensions in this grid extent.
* @throws CannotEvaluateException if this grid extent does not have at
least {@code numDim} dimensions.
*/
diff --git
a/core/sis-feature/src/main/java/org/apache/sis/feature/ExpressionOperation.java
b/core/sis-feature/src/main/java/org/apache/sis/feature/ExpressionOperation.java
index 7b897b979a..4ac9906e60 100644
---
a/core/sis-feature/src/main/java/org/apache/sis/feature/ExpressionOperation.java
+++
b/core/sis-feature/src/main/java/org/apache/sis/feature/ExpressionOperation.java
@@ -174,7 +174,7 @@ final class ExpressionOperation<V> extends
AbstractOperation {
}
/**
- * Delegates the computation to the user-supplied expression.
+ * Delegates the computation to the user supplied expression.
*/
@Override
public V getValue() {
diff --git
a/core/sis-feature/src/main/java/org/apache/sis/filter/ConvertFunction.java
b/core/sis-feature/src/main/java/org/apache/sis/filter/ConvertFunction.java
index 5d5ae63761..17a08e37ef 100644
--- a/core/sis-feature/src/main/java/org/apache/sis/filter/ConvertFunction.java
+++ b/core/sis-feature/src/main/java/org/apache/sis/filter/ConvertFunction.java
@@ -123,7 +123,7 @@ final class ConvertFunction<R,S,V> extends
UnaryFunction<R,S>
/**
* Returns the manner in which values are computed from given resources.
- * This expression can be represented as the concatenation of the
user-supplied expression with the converter.
+ * This expression can be represented as the concatenation of the user
supplied expression with the converter.
* Because this {@code ConvertFunction} does nothing on its own, it does
not have its own set of properties.
*/
@Override
diff --git
a/core/sis-feature/src/main/java/org/apache/sis/image/ImageProcessor.java
b/core/sis-feature/src/main/java/org/apache/sis/image/ImageProcessor.java
index 0185e50ae6..9b92aecd31 100644
--- a/core/sis-feature/src/main/java/org/apache/sis/image/ImageProcessor.java
+++ b/core/sis-feature/src/main/java/org/apache/sis/image/ImageProcessor.java
@@ -409,7 +409,7 @@ public class ImageProcessor implements Cloneable {
}
/**
- * Returns the colors to use for given categories of sample values, or
{@code null} is unspecified.
+ * Returns the colors to use for given categories of sample values, or
{@code null} if unspecified.
* This method returns the function set by the last call to {@link
#setCategoryColors(Function)}.
*
* @return colors to use for arbitrary categories of sample values, or
{@code null} for default.
@@ -422,7 +422,7 @@ public class ImageProcessor implements Cloneable {
}
/**
- * Sets the colors to use for given categories in image, or {@code null}
is unspecified.
+ * Sets the colors to use for given categories in image, or {@code null}
if unspecified.
* This function provides a way to colorize images without knowing in
advance the numerical values of pixels.
* For example, instead of specifying <cite>"pixel value 0 is blue, 1 is
green, 2 is yellow"</cite>,
* this function allows to specify <cite>"Lakes are blue, Forests are
green, Sand is yellow"</cite>.
diff --git
a/core/sis-feature/src/main/java/org/apache/sis/internal/coverage/j2d/ObservableImage.java
b/core/sis-feature/src/main/java/org/apache/sis/internal/coverage/j2d/ObservableImage.java
index 9872e12b3b..a7ad68b0f6 100644
---
a/core/sis-feature/src/main/java/org/apache/sis/internal/coverage/j2d/ObservableImage.java
+++
b/core/sis-feature/src/main/java/org/apache/sis/internal/coverage/j2d/ObservableImage.java
@@ -30,7 +30,7 @@ import org.apache.sis.util.ArraysExt;
/**
- * A buffered image which can notify tile observers when tile are acquired fir
write operations.
+ * A buffered image which cannotify tile observers when tile are acquired fir
write operations.
* Provides also helper methods for {@link WritableRenderedImage}
implementations.
*
* <p>This class should be used in preference to {@link BufferedImage} when
the image may be the
diff --git
a/core/sis-metadata/src/main/java/org/apache/sis/xml/MarshalContext.java
b/core/sis-metadata/src/main/java/org/apache/sis/xml/MarshalContext.java
index 4b1f70df9e..1b56082fb9 100644
--- a/core/sis-metadata/src/main/java/org/apache/sis/xml/MarshalContext.java
+++ b/core/sis-metadata/src/main/java/org/apache/sis/xml/MarshalContext.java
@@ -54,7 +54,7 @@ public abstract class MarshalContext {
* 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.
+ * @return the locale for the XML fragment being (un)marshalled, or {@code
null} if unspecified.
*
* @see org.apache.sis.util.DefaultInternationalString#toString(Locale)
*/
diff --git
a/core/sis-portrayal/src/main/java/org/apache/sis/portrayal/MapLayers.java
b/core/sis-portrayal/src/main/java/org/apache/sis/portrayal/MapLayers.java
index f41717cdb9..988b38bd62 100644
--- a/core/sis-portrayal/src/main/java/org/apache/sis/portrayal/MapLayers.java
+++ b/core/sis-portrayal/src/main/java/org/apache/sis/portrayal/MapLayers.java
@@ -101,7 +101,7 @@ public class MapLayers extends MapItem {
};
/**
- * The area of interest, or {@code null} is unspecified.
+ * The area of interest, or {@code null} if unspecified.
*/
private ImmutableEnvelope areaOfInterest;
@@ -137,7 +137,7 @@ public class MapLayers extends MapItem {
* of data. The returned envelope may have {@linkplain
org.apache.sis.geometry.GeneralEnvelope#isAllNaN()
* all its coordinates set to NaN} if only the {@link
CoordinateReferenceSystem} is specified.</p>
*
- * @return map area to show by default, or {@code null} is unspecified.
+ * @return map area to show by default, or {@code null} if unspecified.
*
* @see DataSet#getEnvelope()
*/
@@ -150,7 +150,7 @@ public class MapLayers extends MapItem {
* The given envelope is not necessarily related to the data contained in
this group.
* It may be wider, or smaller, and in a different {@link
CoordinateReferenceSystem}.
*
- * @param newValue new map area to show by default, or {@code null} is
unspecified.
+ * @param newValue new map area to show by default, or {@code null} if
unspecified.
*/
public void setAreaOfInterest(final Envelope newValue) {
final ImmutableEnvelope imenv = ImmutableEnvelope.castOrCopy(newValue);
diff --git
a/core/sis-portrayal/src/main/java/org/apache/sis/style/se1/Rule.java
b/core/sis-portrayal/src/main/java/org/apache/sis/style/se1/Rule.java
index 36055b9671..54a28658cc 100644
--- a/core/sis-portrayal/src/main/java/org/apache/sis/style/se1/Rule.java
+++ b/core/sis-portrayal/src/main/java/org/apache/sis/style/se1/Rule.java
@@ -274,7 +274,7 @@ public class Rule<R> extends StyleElement<R> {
* If this is true, then the {@linkplain #getFilter() filter} should be
ignored.
*
* <p>The "Else Filter" is implicitly a filter with a condition that
depends on the enclosing style.
- * Consequently, it can not be expressed as a standalone {@code Filter}
expression in this rule.</p>
+ * Consequently, it cannot be expressed as a standalone {@code Filter}
expression in this rule.</p>
*
* @return true if the filter is an else filter.
*/
@@ -314,7 +314,7 @@ public class Rule<R> extends StyleElement<R> {
* <h4>Relationship with real world lengths</h4>
* The values used are scale denominators relative to a “standardized
rendering pixel size”.
* That size is defined as a square with sides of 0.28 millimeters. If the
real pixel size
- * is different or if the CRS uses angular units instead than linear, then
the renderer shall
+ * is different or if the CRS uses angular units instead of linear, then
the renderer shall
* take those information in account as described in OGC 05-077r4 §10.2.
*
* @return minimum scale value, inclusive.
diff --git
a/core/sis-portrayal/src/main/java/org/apache/sis/style/se1/StyleElement.java
b/core/sis-portrayal/src/main/java/org/apache/sis/style/se1/StyleElement.java
index 55df55df04..6054633e19 100644
---
a/core/sis-portrayal/src/main/java/org/apache/sis/style/se1/StyleElement.java
+++
b/core/sis-portrayal/src/main/java/org/apache/sis/style/se1/StyleElement.java
@@ -29,7 +29,7 @@ import org.opengis.filter.Literal;
/**
* Base class of all style objects.
- * This base class can not be extended directly.
+ * This base class cannot be extended directly.
* Instead, one of the subclasses can be extended.
*
* @author Martin Desruisseaux (Geomatys)
diff --git
a/core/sis-portrayal/src/main/java/org/apache/sis/style/se1/Symbolizer.java
b/core/sis-portrayal/src/main/java/org/apache/sis/style/se1/Symbolizer.java
index 743e2d87a1..7bb412785d 100644
--- a/core/sis-portrayal/src/main/java/org/apache/sis/style/se1/Symbolizer.java
+++ b/core/sis-portrayal/src/main/java/org/apache/sis/style/se1/Symbolizer.java
@@ -27,6 +27,8 @@ import jakarta.xml.bind.annotation.XmlAttribute;
import jakarta.xml.bind.annotation.XmlSeeAlso;
import org.apache.sis.measure.Units;
import org.apache.sis.util.resources.Errors;
+
+// Branch-depend imports
import org.opengis.filter.Expression;
import org.opengis.filter.ValueReference;
diff --git
a/core/sis-portrayal/src/test/java/org/apache/sis/style/se1/StyleTestCase.java
b/core/sis-portrayal/src/test/java/org/apache/sis/style/se1/StyleTestCase.java
index bd2fe221ca..2dcd8a37d5 100644
---
a/core/sis-portrayal/src/test/java/org/apache/sis/style/se1/StyleTestCase.java
+++
b/core/sis-portrayal/src/test/java/org/apache/sis/style/se1/StyleTestCase.java
@@ -96,7 +96,7 @@ abstract class StyleTestCase extends TestCase {
}
/**
- * Asserts that the value of the given optional is equals to the expected
value.
+ * Asserts that the value of the given optional is equal to the expected
value.
*
* @param <E> type of object to compare.
* @param expected the expected value.
diff --git
a/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/BursaWolfParameters.java
b/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/BursaWolfParameters.java
index 00b6376f26..35783cdb70 100644
---
a/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/BursaWolfParameters.java
+++
b/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/BursaWolfParameters.java
@@ -217,7 +217,7 @@ public class BursaWolfParameters extends FormattableObject
implements Cloneable,
*
* @param targetDatum the target datum (usually WGS 84) for this set
of parameters, or {@code null} if unknown.
* @param domainOfValidity area or region in which a coordinate
transformation based on those Bursa-Wolf parameters
- * is valid, or {@code null} is unspecified.
+ * is valid, or {@code null} if unspecified.
*/
public BursaWolfParameters(final GeodeticDatum targetDatum, final Extent
domainOfValidity) {
this.targetDatum = targetDatum;
diff --git
a/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/TimeDependentBWP.java
b/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/TimeDependentBWP.java
index c7350ac85d..c12cf71772 100644
---
a/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/TimeDependentBWP.java
+++
b/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/TimeDependentBWP.java
@@ -118,7 +118,7 @@ public class TimeDependentBWP extends BursaWolfParameters {
*
* @param targetDatum the target datum (usually WGS 84) for this set
of parameters.
* @param domainOfValidity area or region in which a coordinate
transformation based on those Bursa-Wolf parameters
- * is valid, or {@code null} is unspecified.
+ * is valid, or {@code null} if unspecified.
* @param timeReference the reference epoch for time-dependent
parameters.
*/
public TimeDependentBWP(final GeodeticDatum targetDatum, final Extent
domainOfValidity, final Date timeReference) {
diff --git
a/storage/sis-geotiff/src/main/java/org/apache/sis/storage/geotiff/ImageMetadataBuilder.java
b/storage/sis-geotiff/src/main/java/org/apache/sis/storage/geotiff/ImageMetadataBuilder.java
index 5ec77cc3c6..8d9ea94142 100644
---
a/storage/sis-geotiff/src/main/java/org/apache/sis/storage/geotiff/ImageMetadataBuilder.java
+++
b/storage/sis-geotiff/src/main/java/org/apache/sis/storage/geotiff/ImageMetadataBuilder.java
@@ -47,7 +47,7 @@ import static javax.imageio.plugins.tiff.BaselineTIFFTagSet.*;
final class ImageMetadataBuilder extends MetadataBuilder {
/**
* The number of pixels per {@link #resolutionUnit} in the image width and
Height directions,
- * or {@link Double#NaN} is unspecified. Since ISO 19115 does not have
separated resolution
+ * or {@link Double#NaN} if unspecified. Since ISO 19115 does not have
separated resolution
* fields for image width and height, Apache SIS stores only the maximal
value.
*/
private double resolution = Double.NaN;
