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 754642811111208a1db1d835c094d919334524fc Author: Martin Desruisseaux <martin.desruisse...@geomatys.com> AuthorDate: Thu Jul 18 09:56:31 2024 +0200 Typo in documentation. --- .../src/main/java/org/apache/sis/buildtools/gradle/Assembler.java | 2 +- buildSrc/src/main/java/org/apache/sis/buildtools/gradle/UnoPkg.java | 2 +- .../main/org/apache/sis/coverage/grid/DimensionReducer.java | 2 +- .../main/org/apache/sis/filter/TemporalFilter.java | 2 +- .../test/org/apache/sis/coverage/grid/ResampledGridCoverageTest.java | 2 +- .../main/org/apache/sis/metadata/privy/ImplementationHelper.java | 2 +- .../main/org/apache/sis/metadata/sql/MetadataSource.java | 2 +- .../main/org/apache/sis/xml/MarshallerPool.java | 2 +- .../main/org/apache/sis/xml/privy/XmlUtilities.java | 2 +- .../test/org/apache/sis/xml/test/PackageVerifier.java | 2 +- .../main/org/apache/sis/referencing/crs/DefaultGeodeticCRS.java | 2 +- .../main/org/apache/sis/referencing/datum/PseudoDatum.java | 4 +++- .../org/apache/sis/referencing/factory/GeodeticObjectFactory.java | 2 +- .../main/org/apache/sis/storage/geotiff/reader/CRSBuilder.java | 2 +- .../org/apache/sis/storage/geotiff/writer/CompressionChannel.java | 2 +- .../main/org/apache/sis/storage/base/MetadataBuilder.java | 2 +- .../org.apache.sis.gui/main/org/apache/sis/gui/internal/FontGIS.java | 2 +- 17 files changed, 19 insertions(+), 17 deletions(-) diff --git a/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/Assembler.java b/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/Assembler.java index 55f5f2af8f..470e06b77e 100644 --- a/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/Assembler.java +++ b/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/Assembler.java @@ -90,7 +90,7 @@ final class Assembler extends ZipWriter.Apache implements FileFilter { private boolean includeDependencies; /** - * Creates an helper object for creating the assembly. + * Creates a helper object for creating the assembly. * * @param project the project for which to create an assembly. * @param out output stream of the ZIP file to create. diff --git a/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/UnoPkg.java b/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/UnoPkg.java index 59c6c527b6..a24f82b675 100644 --- a/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/UnoPkg.java +++ b/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/UnoPkg.java @@ -88,7 +88,7 @@ final class UnoPkg extends ZipWriter.JDK { private static final String FILTERED_VERSION = "${project.version}"; /** - * Creates an helper object for creating the assembly. + * Creates a helper object for creating the assembly. * * @param project the project for which to create an assembly. * @param out output stream of the ZIP file to create. diff --git a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/grid/DimensionReducer.java b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/grid/DimensionReducer.java index 6815cbe74c..29fd52dea9 100644 --- a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/grid/DimensionReducer.java +++ b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/grid/DimensionReducer.java @@ -50,7 +50,7 @@ final class DimensionReducer { private CoordinateReferenceSystem reducedCRS; /** - * Creates an helper which will retain only the {@code targetCRS} dimensions that are found in the base grid. + * Creates a helper which will retain only the {@code targetCRS} dimensions that are found in the base grid. * This will be used by caller for creating a valid {@code sourceCRS} to {@code targetCRS} transform. * * @param base the grid geometry which will be derived. Cannot be null. diff --git a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/TemporalFilter.java b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/TemporalFilter.java index 38d1984a85..8619c71015 100644 --- a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/TemporalFilter.java +++ b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/TemporalFilter.java @@ -158,7 +158,7 @@ class TemporalFilter<R,T> extends BinaryFunction<R,T,T> /** * Casts an expression returning values of unknown type. - * This is an helper function for {@code recreate(…)} method implementations. + * This is a helper function for {@code recreate(…)} method implementations. * * @param effective the expression to cast. * @return an expression that can be used with this temporal filter. diff --git a/endorsed/src/org.apache.sis.feature/test/org/apache/sis/coverage/grid/ResampledGridCoverageTest.java b/endorsed/src/org.apache.sis.feature/test/org/apache/sis/coverage/grid/ResampledGridCoverageTest.java index 76e85b9f35..a80e08e3f3 100644 --- a/endorsed/src/org.apache.sis.feature/test/org/apache/sis/coverage/grid/ResampledGridCoverageTest.java +++ b/endorsed/src/org.apache.sis.feature/test/org/apache/sis/coverage/grid/ResampledGridCoverageTest.java @@ -688,7 +688,7 @@ public final class ResampledGridCoverageTest extends TestCase { /** * Returns an image with only the queries part of the given image. - * This is an helper tools which can be invoked during debugging + * This is a helper tools which can be invoked during debugging * session in IDE capable to display images. * * <h4>Usage</h4> diff --git a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/privy/ImplementationHelper.java b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/privy/ImplementationHelper.java index a0061bbb2b..de1e3393ef 100644 --- a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/privy/ImplementationHelper.java +++ b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/privy/ImplementationHelper.java @@ -35,7 +35,7 @@ import org.apache.sis.util.privy.CollectionsExt; /** * Miscellaneous utility methods for implementation of metadata classes. * Many methods in this class are related to (un)marshalling. - * This is not an helper class for <em>usage</em> of metadata. + * This is not a helper class for <em>usage</em> of metadata. * * @author Martin Desruisseaux (Geomatys) */ diff --git a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/MetadataSource.java b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/MetadataSource.java index b1e7fff38f..ede490d8a9 100644 --- a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/MetadataSource.java +++ b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/MetadataSource.java @@ -705,7 +705,7 @@ public class MetadataSource implements AutoCloseable { * @param columns the table columns as given by {@link #getExistingColumns(String)}, or {@code null}. * @param metadata a map view of the metadata to search for. * @param stmt the statement to use for executing the query. - * @param helper an helper class for creating the SQL query. + * @param helper a helper class for creating the SQL query. * @return the identifier of the given metadata, or {@code null} if none. * @throws SQLException if an error occurred while searching in the database. */ diff --git a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/MarshallerPool.java b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/MarshallerPool.java index 4e59fff574..e5647df787 100644 --- a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/MarshallerPool.java +++ b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/MarshallerPool.java @@ -463,7 +463,7 @@ public class MarshallerPool { /** * Appends the size of the marshaller or unmarshaller pool to the given buffer. - * This is an helper method for {@link #toString()} only. + * This is a helper method for {@link #toString()} only. */ private static boolean appendSize(final StringBuilder buffer, final Deque<?> pool, final String label, boolean s) { int n = pool.size(); diff --git a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/privy/XmlUtilities.java b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/privy/XmlUtilities.java index 5fb093eaf8..f099eb5ac1 100644 --- a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/privy/XmlUtilities.java +++ b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/privy/XmlUtilities.java @@ -354,7 +354,7 @@ public final class XmlUtilities extends SystemListener { /** * Closes the given byte stream and character stream if non-null. - * This is an helper method for {@link #close(Source)} only. + * This is a helper method for {@link #close(Source)} only. */ private static void close(final Closeable b, final Closeable c) throws IOException { if (c != null) c.close(); diff --git a/endorsed/src/org.apache.sis.metadata/test/org/apache/sis/xml/test/PackageVerifier.java b/endorsed/src/org.apache.sis.metadata/test/org/apache/sis/xml/test/PackageVerifier.java index 3146b3ae08..4eb9f6ea66 100644 --- a/endorsed/src/org.apache.sis.metadata/test/org/apache/sis/xml/test/PackageVerifier.java +++ b/endorsed/src/org.apache.sis.metadata/test/org/apache/sis/xml/test/PackageVerifier.java @@ -499,7 +499,7 @@ final class PackageVerifier { /** * Returns a message beginning with "Error in …", to be completed by the caller. - * This is an helper method for exception messages. + * This is a helper method for exception messages. * * @param name the property name, or {@code null} if none. */ diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/crs/DefaultGeodeticCRS.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/crs/DefaultGeodeticCRS.java index c46575f586..a4d5999ad5 100644 --- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/crs/DefaultGeodeticCRS.java +++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/crs/DefaultGeodeticCRS.java @@ -145,7 +145,7 @@ class DefaultGeodeticCRS extends AbstractSingleCRS<GeodeticDatum> implements Geo /** * Returns the datum, or {@code null} if the CRS is associated only to a datum ensemble. * - * This method is overridden is subclasses for documentation purpose only, mostly for showing + * This method is overridden in subclasses for documentation purpose only, mostly for showing * this method in the appropriate position in javadoc (instead of at the bottom of the page). * If {@code DefaultGeodeticCRS} is made public in a future SIS version, then we could remove * the overridden methods. diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/datum/PseudoDatum.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/datum/PseudoDatum.java index 6d13d6200f..f905c6c4f6 100644 --- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/datum/PseudoDatum.java +++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/datum/PseudoDatum.java @@ -186,6 +186,8 @@ public abstract class PseudoDatum<D extends Datum> implements Datum, LenientComp * @return the datum or pseudo-datum of the given <abbr>CRS</abbr>. * @throws NullPointerException if the given argument is {@code null}, * or if both the datum and datum ensemble are null. + * + * @since 2.0 (temporary version number until this branch is released) */ public static ParametricDatum of(final ParametricCRS crs) { ParametricDatum datum = crs.getDatum(); @@ -320,7 +322,7 @@ public abstract class PseudoDatum<D extends Datum> implements Datum, LenientComp * * @param <V> type of value. * @param getter method to invoke on each member for getting the value. - * @return a value common to all members, or {@code null} if none. + * @return a value common to all members, or empty if there is no common value. */ final <V> Optional<V> getCommonOptionalValue(final Function<D, Optional<V>> getter) { final Iterator<D> it = ensemble.getMembers().iterator(); diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticObjectFactory.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticObjectFactory.java index e49f60817e..51d03bcb17 100644 --- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticObjectFactory.java +++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticObjectFactory.java @@ -349,8 +349,8 @@ public class GeodeticObjectFactory extends AbstractFactory implements CRSFactory * @param cs the three-dimensional Cartesian coordinate system for the created CRS. * @throws FactoryException if the object creation failed. * - * @see GeodeticAuthorityFactory#createGeodeticCRS(String) * @see DefaultGeocentricCRS#DefaultGeocentricCRS(Map, GeodeticDatum, DatumEnsemble, CartesianCS) + * @see GeodeticAuthorityFactory#createGeodeticCRS(String) * * @since 1.5 */ diff --git a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/reader/CRSBuilder.java b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/reader/CRSBuilder.java index 041a34a5ad..90c4fb1e7d 100644 --- a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/reader/CRSBuilder.java +++ b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/reader/CRSBuilder.java @@ -235,7 +235,7 @@ public final class CRSBuilder extends ReferencingFactoryContainer { /** * Returns a map with the given name associated to {@value org.opengis.referencing.IdentifiedObject#NAME_KEY}. * The given name shall be either an instance of {@link String} or {@link Identifier}. - * This is an helper method for creating geodetic objects with {@link #getCRSFactory()}. + * This is a helper method for creating geodetic objects with {@link #getCRSFactory()}. */ private Map<String,?> properties(Object name) { if (name == null) { diff --git a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/CompressionChannel.java b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/CompressionChannel.java index cd84ba6295..a5c2de71ad 100644 --- a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/CompressionChannel.java +++ b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/CompressionChannel.java @@ -62,7 +62,7 @@ abstract class CompressionChannel extends PixelChannel { /** * {@return a proposed buffer capacity}. - * This is an helper method for {@link #createBuffer()} implementations. + * This is a helper method for {@link #createBuffer()} implementations. */ final int bufferCapacity() { /* diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/MetadataBuilder.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/MetadataBuilder.java index 56d5255a92..cf29f73e3d 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/MetadataBuilder.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/MetadataBuilder.java @@ -3124,7 +3124,7 @@ public class MetadataBuilder { /** * Appends information from the metadata of a component. - * This is an helper method for building the metadata of an aggregate. + * This is a helper method for building the metadata of an aggregate. * Aggregate metadata should be set before to invoke this method, in particular: * * <ul> diff --git a/optional/src/org.apache.sis.gui/main/org/apache/sis/gui/internal/FontGIS.java b/optional/src/org.apache.sis.gui/main/org/apache/sis/gui/internal/FontGIS.java index 1403029ebf..fcf2e6b870 100644 --- a/optional/src/org.apache.sis.gui/main/org/apache/sis/gui/internal/FontGIS.java +++ b/optional/src/org.apache.sis.gui/main/org/apache/sis/gui/internal/FontGIS.java @@ -65,7 +65,7 @@ public final class FontGIS extends Static { } /** - * Default font size in points. The value was choosen empirically. + * Default font size in points. The value was chosen empirically. */ private static final int DEFAULT_SIZE = 18;