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 85045c993113ebd5c46885d275cb77957a49c410 Author: Martin Desruisseaux <[email protected]> AuthorDate: Mon Oct 13 11:24:40 2025 +0200 Javadoc fixes: the {@return} tag has an implicit dot at the end of sentences. For consistency with usage elsewhere in SIS documentation, remove those tags. The main replacements have been done automatically using a regular expression. --- .../org/apache/sis/buildtools/gradle/BuildHelper.java | 2 +- .../org/apache/sis/buildtools/gradle/Dependency.java | 2 +- .../org/apache/sis/buildtools/gradle/ZipWriter.java | 6 +++--- .../main/org/apache/sis/console/Command.java | 4 +++- .../main/org/apache/sis/console/CommandRunner.java | 4 +++- .../main/org/apache/sis/console/SIS.java | 4 ++-- .../main/org/apache/sis/console/TransformCommand.java | 2 +- .../org/apache/sis/filter/DefaultFilterFactory.java | 4 ++-- .../apache/sis/filter/sqlmm/FunctionDescription.java | 17 +++++++++++------ .../org/apache/sis/geometry/wrapper/GeometryType.java | 3 ++- .../org/apache/sis/geometry/wrapper/j2d/Wrapper.java | 2 +- .../main/org/apache/sis/metadata/TreeTableView.java | 2 +- .../org/apache/sis/metadata/ValueExistencePolicy.java | 2 +- .../sis/metadata/sql/internal/shared/Initializer.java | 4 +++- .../main/org/apache/sis/xml/MarshallerPool.java | 3 ++- .../main/org/apache/sis/xml/Pooled.java | 2 +- .../main/org/apache/sis/xml/bind/Context.java | 2 +- .../main/org/apache/sis/xml/bind/ScopedIdentifier.java | 4 ++-- .../sis/xml/internal/shared/ExternalLinkHandler.java | 6 ++++-- .../org/apache/sis/xml/internal/shared/URISource.java | 2 +- .../org/apache/sis/parameter/DefaultParameterValue.java | 9 +++++++-- .../main/org/apache/sis/parameter/Parameters.java | 5 ++++- .../org/apache/sis/referencing/DefaultObjectDomain.java | 8 ++++++-- .../main/org/apache/sis/referencing/cs/AbstractCS.java | 5 +++-- .../internal/shared/ExtendedPrecisionMatrix.java | 3 ++- .../operation/CoordinateOperationRegistry.java | 7 +++++-- .../sis/referencing/operation/gridded/GridFile.java | 6 +++--- .../sis/referencing/operation/gridded/LoadedGrid.java | 2 +- .../sis/storage/landsat/LandsatStoreProvider.java | 2 +- .../org/apache/sis/storage/geotiff/Compression.java | 2 +- .../org/apache/sis/storage/geotiff/GeoTiffStore.java | 2 +- .../main/org/apache/sis/storage/geotiff/IOBase.java | 6 +++--- .../main/org/apache/sis/storage/geotiff/Reader.java | 2 +- .../main/org/apache/sis/storage/geotiff/Writer.java | 4 ++-- .../apache/sis/storage/geotiff/base/Compression.java | 2 +- .../main/org/apache/sis/storage/geotiff/base/Tags.java | 2 +- .../org/apache/sis/storage/geotiff/base/UnitKey.java | 4 +++- .../sis/storage/geotiff/writer/CompressionChannel.java | 2 +- .../apache/sis/storage/geotiff/writer/GeoEncoder.java | 10 +++++----- .../sis/storage/geotiff/writer/HorizontalPredictor.java | 2 +- .../apache/sis/storage/geotiff/writer/TileMatrix.java | 2 +- .../test/org/apache/sis/storage/geotiff/WriterTest.java | 2 +- .../apache/sis/storage/netcdf/NetcdfStoreProvider.java | 2 +- .../org/apache/sis/storage/sql/SQLStoreProvider.java | 2 +- .../main/org/apache/sis/storage/gpx/StoreProvider.java | 4 ++-- .../org/apache/sis/storage/xml/stream/StaxStreamIO.java | 2 +- .../main/org/apache/sis/io/stream/ChannelData.java | 4 +++- .../main/org/apache/sis/io/stream/ChannelDataInput.java | 4 +++- .../org/apache/sis/io/stream/ChannelDataOutput.java | 4 +++- .../apache/sis/io/stream/ChannelImageOutputStream.java | 6 ++++-- .../org/apache/sis/io/stream/HyperRectangleWriter.java | 16 ++++++++++++---- .../main/org/apache/sis/io/stream/Region.java | 2 +- .../main/org/apache/sis/io/stream/UpdatableWrite.java | 6 +++--- .../main/org/apache/sis/storage/base/PRJDataStore.java | 4 +++- .../org/apache/sis/storage/base/SimpleAggregate.java | 2 +- .../main/org/apache/sis/storage/base/URIDataStore.java | 15 +++++++++++---- .../sis/storage/base/WritableAggregateSupport.java | 4 +++- .../sis/storage/base/WritableGridCoverageSupport.java | 4 +++- .../main/org/apache/sis/storage/csv/StoreProvider.java | 2 +- .../apache/sis/storage/esri/AsciiGridStoreProvider.java | 2 +- .../apache/sis/storage/esri/RawRasterStoreProvider.java | 2 +- .../org/apache/sis/storage/folder/StoreProvider.java | 2 +- .../sis/storage/image/WorldFileStoreProvider.java | 2 +- .../main/org/apache/sis/storage/wkt/StoreProvider.java | 2 +- .../main/org/apache/sis/storage/xml/StoreProvider.java | 2 +- .../test/org/apache/sis/io/stream/ByteArrayChannel.java | 6 +++--- .../org/apache/sis/io/stream/ChannelDataTestCase.java | 14 +++++++------- .../main/org/apache/sis/measure/UnitDimension.java | 5 +++-- .../main/org/apache/sis/pending/jdk/HexFormat.java | 5 +++-- .../main/org/apache/sis/pending/jdk/JDK17.java | 2 +- .../apache/sis/util/internal/shared/DoubleDouble.java | 8 ++++++-- .../org/apache/sis/util/logging/MonolineFormatter.java | 4 +++- .../storage/coveragejson/CoverageJsonStoreProvider.java | 2 +- 73 files changed, 189 insertions(+), 118 deletions(-) diff --git a/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/BuildHelper.java b/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/BuildHelper.java index 7dd86924e3..69106815c2 100644 --- a/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/BuildHelper.java +++ b/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/BuildHelper.java @@ -117,7 +117,7 @@ public final class BuildHelper implements Plugin<Project> { } /** - * {@return the main modules to patch with test classes}. + * Returns the main modules to patch with test classes. */ final Stream<Map.Entry<String,File>> getPatchedDirectories() { return testDirs.entrySet().stream().filter((e) -> mainDirs.containsKey(e.getKey())); diff --git a/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/Dependency.java b/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/Dependency.java index 6900186a82..21e53f58d2 100644 --- a/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/Dependency.java +++ b/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/Dependency.java @@ -269,7 +269,7 @@ public final class Dependency { } /** - * {@return a hash code for this dependency}. + * Returns a hash code for this dependency. */ @Override public int hashCode() { diff --git a/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/ZipWriter.java b/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/ZipWriter.java index 7529994b00..2699d82a5f 100644 --- a/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/ZipWriter.java +++ b/buildSrc/src/main/java/org/apache/sis/buildtools/gradle/ZipWriter.java @@ -65,7 +65,7 @@ abstract class ZipWriter extends Conventions { } /** - * {@return the ZIP output stream}. This is either the JDK {@link ZipArchiveEntry} + * Returns the ZIP output stream. This is either the JDK {@link ZipArchiveEntry} * or the Apache Common Compress {@link ZipArchiveOutputStream} implementation. */ abstract OutputStream out(); @@ -107,7 +107,7 @@ abstract class ZipWriter extends Conventions { out.setLevel(Deflater.BEST_COMPRESSION); } - /** {@return the ZIP output stream}. */ + /** Returns the ZIP output stream. */ @Override final OutputStream out() { return out; } @@ -147,7 +147,7 @@ abstract class ZipWriter extends Conventions { out.setLevel(Deflater.BEST_COMPRESSION); } - /** {@return the ZIP output stream}. */ + /** Returns the ZIP output stream. */ @Override final OutputStream out() { return out; } diff --git a/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/Command.java b/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/Command.java index 055923819e..6f2a20455c 100644 --- a/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/Command.java +++ b/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/Command.java @@ -236,9 +236,11 @@ public final class Command { } /** - * {@return the terminal size if known, of {@link Integer#MAX_VALUE} otherwise}. + * Returns the terminal size if known, of {@link Integer#MAX_VALUE} otherwise. * The returned value may be obsolete, because the {@code COLUMNS} environment * variable is not updated when the user resizes the terminal window. + * + * @return the assumed terminal size. */ private static int terminalSize() { final String n = System.getenv("COLUMNS"); diff --git a/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/CommandRunner.java b/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/CommandRunner.java index 6ea21715e1..de7f183302 100644 --- a/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/CommandRunner.java +++ b/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/CommandRunner.java @@ -263,9 +263,11 @@ abstract class CommandRunner { } /** - * {@return a non-null timezone, either the specified timezone or the default one}. + * Returns a non-null timezone, either the specified timezone or the default one. * This method is invoked when a null {@link #timezone} would be interpreted as UTC, * but the {@linkplain TimeZone#getDefault() default timezone} is preferred instead. + * + * @return the timezone to use. */ protected final TimeZone getTimeZone() { return (timezone != null) ? TimeZone.getTimeZone(timezone) : TimeZone.getDefault(); diff --git a/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/SIS.java b/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/SIS.java index d989c11e6e..b57743ad88 100644 --- a/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/SIS.java +++ b/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/SIS.java @@ -196,7 +196,7 @@ public final class SIS { } /** - * {@return the command with all options that have been set}. + * Returns the command with all options that have been set. */ @Override public String toString() { @@ -214,7 +214,7 @@ public final class SIS { } /** - * {@return a string representation of the Apache SIS version}. + * Returns a string representation of the Apache SIS version. * * @see Version#SIS */ diff --git a/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/TransformCommand.java b/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/TransformCommand.java index 033046b050..0a91dd424b 100644 --- a/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/TransformCommand.java +++ b/endorsed/src/org.apache.sis.console/main/org/apache/sis/console/TransformCommand.java @@ -706,7 +706,7 @@ final class TransformCommand extends FormattedOutputCommand { } /** - * {@return the math transform of the operation, inverted if requested by user}. + * Returns the math transform of the operation, inverted if requested by user. */ private MathTransform getMathTransform() throws NoninvertibleTransformException { MathTransform mt = operation.getMathTransform(); diff --git a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/DefaultFilterFactory.java b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/DefaultFilterFactory.java index ba50e7bbff..73d2ed0d0d 100644 --- a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/DefaultFilterFactory.java +++ b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/DefaultFilterFactory.java @@ -1106,7 +1106,7 @@ public abstract class DefaultFilterFactory<R,G,T> extends AbstractFactory implem } /** - * {@return the number of functions}. + * Returns the number of functions. */ @Override public int size() { @@ -1136,7 +1136,7 @@ public abstract class DefaultFilterFactory<R,G,T> extends AbstractFactory implem } /** - * {@return an iterator over the entries in this map}. + * Returns an iterator over the entries in this map. */ @Override protected EntryIterator<String, AvailableFunction> entryIterator() { diff --git a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/FunctionDescription.java b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/FunctionDescription.java index 263646d4b7..2f60877371 100644 --- a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/FunctionDescription.java +++ b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/FunctionDescription.java @@ -127,7 +127,7 @@ final class FunctionDescription implements AvailableFunction, Serializable { } /** - * {@return the type of return value}. + * Returns the type of return value. */ @Override public TypeName getReturnType() { @@ -142,6 +142,7 @@ final class FunctionDescription implements AvailableFunction, Serializable { * * @param <T> the type of the argument value. */ + @SuppressWarnings("EqualsAndHashcode") private static final class Argument<T> extends SimpleIdentifiedObject implements ParameterDescriptor<T> { /** * For cross-version compatibility. @@ -180,7 +181,7 @@ final class FunctionDescription implements AvailableFunction, Serializable { } /** - * {@return the name of the type of the argument}. + * Returns the name of the type of the argument. */ @Override public TypeName getValueType() { @@ -268,7 +269,7 @@ final class FunctionDescription implements AvailableFunction, Serializable { } /** - * {@return a hash-code value for this argument description}. + * Returns a hash-code value for this argument description. */ @Override public int hashCode() { @@ -276,9 +277,11 @@ final class FunctionDescription implements AvailableFunction, Serializable { } /** - * {@return a string representation of this argument}. + * Returns a string representation of this argument. * Current version includes the name and the type. * Should be used only for debugging purposes. + * + * @return a string representation for debugging purposes. */ @Override public String toString() { @@ -318,7 +321,7 @@ final class FunctionDescription implements AvailableFunction, Serializable { } /** - * {@return a hash-code value for this function description}. + * Returns a hash-code value for this function description. */ @Override public int hashCode() { @@ -326,8 +329,10 @@ final class FunctionDescription implements AvailableFunction, Serializable { } /** - * {@return a string representation of this function with its argument}. + * Returns a string representation of this function with its argument. * Should be used only for debugging purposes. + * + * @return a string representation for debugging purposes. */ @Override public String toString() { diff --git a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/geometry/wrapper/GeometryType.java b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/geometry/wrapper/GeometryType.java index b835cf004a..b40a61f249 100644 --- a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/geometry/wrapper/GeometryType.java +++ b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/geometry/wrapper/GeometryType.java @@ -262,10 +262,11 @@ public enum GeometryType { } /** - * {@return the name of this geometry type as an ISO 19103 object}. + * Returns the name of this geometry type as an ISO 19103 object. * The namespace is "OGC". The Java type depends on the geometry library. * * @param library the geometry library that determine geometry classes. + * @return a name identifying this geometry and its implementation class. */ public final TypeName getTypeName(final Geometries<?> library) { TypeName value; diff --git a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/geometry/wrapper/j2d/Wrapper.java b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/geometry/wrapper/j2d/Wrapper.java index 167b8263d3..8c47606370 100644 --- a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/geometry/wrapper/j2d/Wrapper.java +++ b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/geometry/wrapper/j2d/Wrapper.java @@ -198,7 +198,7 @@ add: for (;;) { } /** - * {@return directly the underlying Java2D geometry}. This method does not copy the shape. + * Returns directly the underlying Java2D geometry. This method does not copy the shape. * Caller should not modify the returned shape (by casting to an implementation class). */ @Override diff --git a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/TreeTableView.java b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/TreeTableView.java index 2c5ecbe548..c7994c5064 100644 --- a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/TreeTableView.java +++ b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/TreeTableView.java @@ -113,7 +113,7 @@ final class TreeTableView implements TreeTable, TreeFormatCustomization, Seriali } /** - * {@return the columns included in this tree table}. + * Returns the columns included in this tree table. */ @Override @SuppressWarnings("ReturnOfCollectionOrArrayField") // Because the returned collection is unmodifiable. diff --git a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/ValueExistencePolicy.java b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/ValueExistencePolicy.java index b0a8adcd0d..e050b230f8 100644 --- a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/ValueExistencePolicy.java +++ b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/ValueExistencePolicy.java @@ -186,7 +186,7 @@ public enum ValueExistencePolicy { }; /** - * {@return whether this policy accepts nil values}. + * Returns whether this policy accepts nil values. */ final boolean acceptNilValues() { return ordinal() < NON_NIL.ordinal(); diff --git a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/internal/shared/Initializer.java b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/internal/shared/Initializer.java index ad80ddb0d0..1f820d48ff 100644 --- a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/internal/shared/Initializer.java +++ b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/sql/internal/shared/Initializer.java @@ -112,7 +112,9 @@ public abstract class Initializer { } /** - * {@return initializers found on the module path}. + * Returns initializers found on the module path. + * + * @return all registered initializers. */ public static ServiceLoader<Initializer> load() { try { 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 8933aeb7b4..fab230c96d 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 @@ -454,10 +454,11 @@ public class MarshallerPool { } /** - * {@return a string representation of this pool for debugging purposes}. + * Returns a string representation of this pool for debugging purposes. * The string representation is unspecified and may change in any future * Apache SIS version. * + * @return a string representation for debugging purposes. * @since 1.5 */ @Override diff --git a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/Pooled.java b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/Pooled.java index 8959fc417a..5327eea246 100644 --- a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/Pooled.java +++ b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/Pooled.java @@ -584,7 +584,7 @@ abstract class Pooled { } /** - * {@return a string representation of this (un)marshaller for debugging purposes}. + * Returns a string representation of this (un)marshaller for debugging purposes. */ @Override public String toString() { diff --git a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/Context.java b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/Context.java index 5df0a1d981..685f3f9310 100644 --- a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/Context.java +++ b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/Context.java @@ -900,7 +900,7 @@ public final class Context extends MarshalContext { } /** - * {@return a string representation of this context for debugging purposes}. + * Returns a string representation of this context for debugging purposes. */ @Override public String toString() { diff --git a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/ScopedIdentifier.java b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/ScopedIdentifier.java index dd23d38016..cbc024e9fd 100644 --- a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/ScopedIdentifier.java +++ b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/ScopedIdentifier.java @@ -113,7 +113,7 @@ public final class ScopedIdentifier<T> { } /** - * {@return an hash code value for this key}. + * Returns an hash code value for this key. */ @Override public int hashCode() { @@ -136,7 +136,7 @@ public final class ScopedIdentifier<T> { } /** - * {@return a string representation for debugging purposes}. + * Returns a string representation for debugging purposes. */ @Override public String toString() { diff --git a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/internal/shared/ExternalLinkHandler.java b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/internal/shared/ExternalLinkHandler.java index 95228e4a88..068f6a6b27 100644 --- a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/internal/shared/ExternalLinkHandler.java +++ b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/internal/shared/ExternalLinkHandler.java @@ -127,8 +127,10 @@ public class ExternalLinkHandler { } /** - * {@return the base URI of the link handler}. The returned object may be an instance of + * Returns the base URI of the link handler. The returned object may be an instance of * {@link String}, {@link File}, {@link URL} or {@link URI}, or it may be {@code null}. + * + * @return the base <abbr>URI</abbr>, or {@code null}. */ public final Object getBase() { return base; @@ -308,7 +310,7 @@ public class ExternalLinkHandler { } /** - * {@return a string representation of this link handler for debugging purposes}. + * Returns a string representation of this link handler for debugging purposes. */ @Override public String toString() { diff --git a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/internal/shared/URISource.java b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/internal/shared/URISource.java index bbd64d970b..9928d89dfa 100644 --- a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/internal/shared/URISource.java +++ b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/internal/shared/URISource.java @@ -115,7 +115,7 @@ public final class URISource extends StreamSource { } /** - * {@return a string representation of this source for debugging purposes}. + * Returns a string representation of this source for debugging purposes. */ @Override public String toString() { diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/parameter/DefaultParameterValue.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/parameter/DefaultParameterValue.java index 196ae7b824..9d3eedd3a3 100644 --- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/parameter/DefaultParameterValue.java +++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/parameter/DefaultParameterValue.java @@ -238,7 +238,9 @@ public class DefaultParameterValue<T> extends FormattableObject implements Param } /** - * {@return the definition of this parameter}. + * Returns the definition of this parameter. + * + * @return description of this parameter. */ @Override @XmlElement(name = "operationParameter", required = true) @@ -247,7 +249,8 @@ public class DefaultParameterValue<T> extends FormattableObject implements Param } /** - * {@return the URI of the GML document or WKT file from which this parameter value has been read}. + * Returns the <abbr>URI</abbr> of the <abbr>GML</abbr> document + * or <abbr>WKT</abbr> file from which the parameter values are read. * This information allows to interpret {@link #valueFile()} as a path relative to the file that defined * this parameter value. For example, the following snippet gets the file, then tries to make it absolute: * @@ -257,6 +260,8 @@ public class DefaultParameterValue<T> extends FormattableObject implements Param * file = pv.getSourceFile().map((base) -> base.resolve(file)).orElse(file); * } * + * @return the <abbr>URI</abbr> of the document from which the parameter values are read. + * * @see #setSourceFile(URI) * @see Parameters#getSourceFile(ParameterDescriptor) * @see org.apache.sis.io.wkt.WKTFormat#getSourceFile() diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/parameter/Parameters.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/parameter/Parameters.java index 49534f916c..ee2ff644e4 100644 --- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/parameter/Parameters.java +++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/parameter/Parameters.java @@ -516,12 +516,15 @@ public abstract class Parameters implements ParameterValueGroup, Cloneable, Prin } /** - * {@return the URI of the GML document or WKT file from which a parameter value has been read}. + * Returns the <abbr>URI</abbr> of the <abbr>GML</abbr> document + * or <abbr>WKT</abbr> file from which the parameter values are read. * This information can be used together with {@code getValue(ParameterDescriptor<URI>)} for * resolving a parameter value as a path relative to the GML or WKT file declaring the parameter. * Note that the source file is not necessarily the same for all parameters in a group, because a GML * document could define parameters in files referenced by different {@code xlink:href} attribute values. * + * @return the <abbr>URI</abbr> of the document from which the parameter values are read. + * * @see DefaultParameterValue#getSourceFile() * @see org.apache.sis.io.wkt.WKTFormat#getSourceFile() * @see org.apache.sis.xml.MarshalContext#getDocumentURI() diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/DefaultObjectDomain.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/DefaultObjectDomain.java index cafb182b67..1746782385 100644 --- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/DefaultObjectDomain.java +++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/DefaultObjectDomain.java @@ -76,7 +76,9 @@ public class DefaultObjectDomain extends FormattableObject implements ObjectDoma } /** - * {@return a reason saying that the extent is unknown}. + * Returns a reason saying that the extent is unknown. + * + * @return reason why the extent is unknown. */ @Override public NilReason getNilReason() { @@ -111,7 +113,9 @@ public class DefaultObjectDomain extends FormattableObject implements ObjectDoma } /** - * {@return a reason saying that the extent is unknown}. + * Returns a reason saying that the extent is unknown. + * + * @return reason why the extent is unknown. */ @Override public NilReason getNilReason() { diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/cs/AbstractCS.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/cs/AbstractCS.java index 2e588160ef..ba1bc7fc43 100644 --- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/cs/AbstractCS.java +++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/cs/AbstractCS.java @@ -393,7 +393,7 @@ public class AbstractCS extends AbstractIdentifiedObject implements CoordinateSy } /** - * {@return whether this coordinate system has the same axes as the specified CS, ignoring axis order}. + * Returns whether this coordinate system has the same axes as the specified CS, ignoring axis order. * If true, then the two coordinate systems have the same number of dimensions and the same set of axes. * Axis instances are compared by the identity operator ({@code ==}), not by {@code equals(Object)}. * @@ -401,7 +401,8 @@ public class AbstractCS extends AbstractIdentifiedObject implements CoordinateSy * This method can be invoked after a call to {@link #forConvention(AxesConvention)} for checking if that * method changed only the axis order, with no change to axis directions, axis ranges or units of measurement. * - * @param other the other coordinate system to compare with this CS. + * @param other the other coordinate system to compare with this <abbr>CS</abbr>. + * @return whether this coordinate system has the same axes as the specified <abbr>CS</abbr>. * * @since 1.5 */ diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/internal/shared/ExtendedPrecisionMatrix.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/internal/shared/ExtendedPrecisionMatrix.java index 436738285c..ed1d2d72fb 100644 --- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/internal/shared/ExtendedPrecisionMatrix.java +++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/internal/shared/ExtendedPrecisionMatrix.java @@ -55,10 +55,11 @@ public interface ExtendedPrecisionMatrix extends Matrix { } /** - * {@return an extended-precision view of the given matrix}. + * Returns an extended-precision view of the given matrix. * The returned matrix should be assumed read-only. * * @param m the matrix to cast or wrap. + * @eturn an extended-precision view of the matrix. * * @see org.apache.sis.referencing.operation.matrix.MatrixSIS#asExtendedPrecision(Matrix) */ diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/CoordinateOperationRegistry.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/CoordinateOperationRegistry.java index 58a2f1df00..879c95ea66 100644 --- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/CoordinateOperationRegistry.java +++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/CoordinateOperationRegistry.java @@ -1392,16 +1392,19 @@ class CoordinateOperationRegistry { } /** - * {@return the localized resources for error messages}. + * Returns the localized resources for error messages. + * + * @return localized resources for errors. */ final Resources resources() { return Resources.forLocale(locale); } /** - * {@return a label for identifying the given object in error message}. + * Returns a label for identifying the given object in error message. * * @param object the object of identify. + * @return label identifying the given object. */ final String label(final IdentifiedObject object) { return CRSPair.label(object, locale); diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/gridded/GridFile.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/gridded/GridFile.java index f09e562078..f3d2e53c4b 100644 --- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/gridded/GridFile.java +++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/gridded/GridFile.java @@ -196,7 +196,7 @@ public final class GridFile { } /** - * {@return the resolved URI}. + * Returns the resolved <abbr>URI</abbr>. * * @see #parameter */ @@ -205,7 +205,7 @@ public final class GridFile { } /** - * {@return the resolved URI as a path if possible}. + * Returns the resolved <abbr>URI</abbr> as a path if possible. * A use case for this method is grids to open as a {@link org.apache.sis.storage.DataStore}. */ public Optional<Path> path() { @@ -293,7 +293,7 @@ public final class GridFile { } /** - * {@return a string representation of this path for debugging purposes}. + * Returns a string representation of this path for debugging purposes. */ @Override public String toString() { diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/gridded/LoadedGrid.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/gridded/LoadedGrid.java index fee5ca293b..6da8da23d9 100644 --- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/gridded/LoadedGrid.java +++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/gridded/LoadedGrid.java @@ -302,7 +302,7 @@ public abstract class LoadedGrid<C extends Quantity<C>, T extends Quantity<T>> e } /** - * {@return a string representation of this grid for debugging purpose}. + * Returns a string representation of this grid for debugging purpose. * If this grid has children, then they will be formatted as a tree. */ @Override diff --git a/endorsed/src/org.apache.sis.storage.earthobservation/main/org/apache/sis/storage/landsat/LandsatStoreProvider.java b/endorsed/src/org.apache.sis.storage.earthobservation/main/org/apache/sis/storage/landsat/LandsatStoreProvider.java index 9ca9da35b9..53f33c75cd 100644 --- a/endorsed/src/org.apache.sis.storage.earthobservation/main/org/apache/sis/storage/landsat/LandsatStoreProvider.java +++ b/endorsed/src/org.apache.sis.storage.earthobservation/main/org/apache/sis/storage/landsat/LandsatStoreProvider.java @@ -226,7 +226,7 @@ public class LandsatStoreProvider extends DataStoreProvider { } /** - * {@return the logger used by Landsat stores}. + * Returns the logger used by Landsat stores. */ @Override public Logger getLogger() { diff --git a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/Compression.java b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/Compression.java index 80de2aed76..b034ee6507 100644 --- a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/Compression.java +++ b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/Compression.java @@ -196,7 +196,7 @@ public final class Compression implements Serializable { } /** - * {@return whether the compression method may use predictor}. + * Returns whether the compression method may use predictor. */ final boolean usePredictor() { return level != 0; diff --git a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/GeoTiffStore.java b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/GeoTiffStore.java index 0854462400..3ffe5083f8 100644 --- a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/GeoTiffStore.java +++ b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/GeoTiffStore.java @@ -499,7 +499,7 @@ public class GeoTiffStore extends DataStore implements Aggregate { } /** - * {@return the object to use for parsing and formatting dates}. + * Returns the object to use for parsing and formatting dates. */ final DateFormat getDateFormat() { if (dateFormat == null) { diff --git a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/IOBase.java b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/IOBase.java index cdb40b9fcf..8795c3a1a3 100644 --- a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/IOBase.java +++ b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/IOBase.java @@ -59,21 +59,21 @@ abstract class IOBase implements Closeable { } /** - * {@return the modifiers (BigTIFF, COG…) used by this reader or writer}. + * Returns the modifiers (BigTIFF, <abbr>COG</abbr>…) used by this reader or writer. * * @see GeoTiffStore#getModifiers() */ public abstract Set<FormatModifier> getModifiers(); /** - * {@return the resources to use for formatting error messages}. + * Returns the resources to use for formatting error messages. */ final Errors errors() { return Errors.forLocale(store.getLocale()); } /** - * {@return the GeoTIFF-specific resource for error messages and warnings}. + * Returns the GeoTIFF-specific resource for error messages and warnings. */ final Resources resources() { return Resources.forLocale(store.getLocale()); diff --git a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/Reader.java b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/Reader.java index 7a838577a0..164cfb6c56 100644 --- a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/Reader.java +++ b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/Reader.java @@ -189,7 +189,7 @@ final class Reader extends IOBase { } /** - * {@return the modifiers (BigTIFF, COG…) used by this reader}. + * Returns the modifiers (BigTIFF, <abbr>COG</abbr>…) used by this reader. */ @Override public final Set<FormatModifier> getModifiers() { diff --git a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/Writer.java b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/Writer.java index a774a6706a..3926b00baf 100644 --- a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/Writer.java +++ b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/Writer.java @@ -264,7 +264,7 @@ final class Writer extends IOBase implements Flushable { } /** - * {@return the modifiers (BigTIFF, COG…) used by this writer}. + * Returns the modifiers (BigTIFF, <abbr>COG</abbr>…) used by this writer. */ @Override public final Set<FormatModifier> getModifiers() { @@ -272,7 +272,7 @@ final class Writer extends IOBase implements Flushable { } /** - * {@return the processor to use for reformatting the image before to write it}. + * Returns the processor to use for reformatting the image before to write it. * The processor is created only when this method is first invoked. */ private ImageProcessor processor() { diff --git a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/base/Compression.java b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/base/Compression.java index 22ed417e36..bfbabadc10 100644 --- a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/base/Compression.java +++ b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/base/Compression.java @@ -172,7 +172,7 @@ public enum Compression { } /** - * {@return whether the compression can be configured with different levels}. + * Returns whether the compression can be configured with different levels. */ public final boolean supportLevels() { return this == DEFLATE; diff --git a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/base/Tags.java b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/base/Tags.java index f301a7a166..50eb9c9f38 100644 --- a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/base/Tags.java +++ b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/base/Tags.java @@ -92,7 +92,7 @@ public final class Tags { } /** - * {@return the name of the given tag}. + * Returns the name of the given tag. * This method should be rarely invoked (mostly for formatting error messages). */ public static String name(final short tag) { diff --git a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/base/UnitKey.java b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/base/UnitKey.java index b8c4e16c3c..bc5956f132 100644 --- a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/base/UnitKey.java +++ b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/base/UnitKey.java @@ -175,7 +175,9 @@ public enum UnitKey { } /** - * {@return the default unit of measurement, or {@code null} if none}. + * Returns the default unit of measurement, or {@code null} if none. + * + * @return default unit of measurement (if any) for this key. */ public Unit<?> defaultUnit() { if (linear) return Units.METRE; 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 b770237f6e..0b94462cb5 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 @@ -61,7 +61,7 @@ abstract class CompressionChannel extends PixelChannel { } /** - * {@return a proposed buffer capacity}. + * Returns a proposed buffer capacity. * This is a helper method for {@link #createBuffer()} implementations. */ final int bufferCapacity() { diff --git a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/GeoEncoder.java b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/GeoEncoder.java index 6620c85fb5..03b2f6b0d7 100644 --- a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/GeoEncoder.java +++ b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/GeoEncoder.java @@ -838,7 +838,7 @@ public final class GeoEncoder { } /** - * {@return the values to write in the "GeoTIFF keys directory" tag}. + * Returns the values to write in the "GeoTIFF keys directory" tag. */ public short[] keyDirectory() { if (keyCount == 0) return null; @@ -847,7 +847,7 @@ public final class GeoEncoder { } /** - * {@return the values to write in the "GeoTIFF double-precision parameters" tag}. + * Returns the values to write in the "GeoTIFF double-precision parameters" tag. */ public double[] doubleParams() { if (doubleCount == 0) return null; @@ -855,7 +855,7 @@ public final class GeoEncoder { } /** - * {@return the values to write in the "GeoTIFF ASCII strings" tag}. + * Returns the values to write in the "GeoTIFF ASCII strings" tag. */ public List<String> asciiParams() { return JDK15.isEmpty(asciiParams) ? null : List.of(asciiParams.toString()); @@ -944,14 +944,14 @@ public final class GeoEncoder { } /** - * {@return the resources for error messages in the current locale}. + * Returns the resources for error messages in the current locale. */ private Errors errors() { return Errors.forLocale(listeners.getLocale()); } /** - * {@return the resources in the current locale}. + * Returns the resources in the current locale. */ private Resources resources() { return Resources.forLocale(listeners.getLocale()); diff --git a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/HorizontalPredictor.java b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/HorizontalPredictor.java index a352558315..8be172fcd6 100644 --- a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/HorizontalPredictor.java +++ b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/HorizontalPredictor.java @@ -82,7 +82,7 @@ abstract class HorizontalPredictor extends PredictorChannel { } /** - * {@return the size of sample values in number of bytes}. + * Returns the size of sample values in number of bytes. */ abstract int sampleSize(); diff --git a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/TileMatrix.java b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/TileMatrix.java index d7046f6661..a982e93717 100644 --- a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/TileMatrix.java +++ b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/TileMatrix.java @@ -152,7 +152,7 @@ public final class TileMatrix { } /** - * {@return whether to use strips instead of tiles}. + * Returns whether to use strips instead of tiles. * This is {@code true} if image rows are not separated in tiles. * The purpose of using strips is to avoid the restriction that tile size must be multiple of 16 bytes. */ diff --git a/endorsed/src/org.apache.sis.storage.geotiff/test/org/apache/sis/storage/geotiff/WriterTest.java b/endorsed/src/org.apache.sis.storage.geotiff/test/org/apache/sis/storage/geotiff/WriterTest.java index 7368158147..edb7c694d0 100644 --- a/endorsed/src/org.apache.sis.storage.geotiff/test/org/apache/sis/storage/geotiff/WriterTest.java +++ b/endorsed/src/org.apache.sis.storage.geotiff/test/org/apache/sis/storage/geotiff/WriterTest.java @@ -464,7 +464,7 @@ public final class WriterTest extends TestCase { } /** - * {@return the uncompressed size in bytes of each tile}. + * Returns the uncompressed size in bytes of each tile. */ private int[] expectedTileByteCounts() { final SampleModel sm = image.getSampleModel(); diff --git a/endorsed/src/org.apache.sis.storage.netcdf/main/org/apache/sis/storage/netcdf/NetcdfStoreProvider.java b/endorsed/src/org.apache.sis.storage.netcdf/main/org/apache/sis/storage/netcdf/NetcdfStoreProvider.java index 4abde5ef2e..2deae29e12 100644 --- a/endorsed/src/org.apache.sis.storage.netcdf/main/org/apache/sis/storage/netcdf/NetcdfStoreProvider.java +++ b/endorsed/src/org.apache.sis.storage.netcdf/main/org/apache/sis/storage/netcdf/NetcdfStoreProvider.java @@ -457,7 +457,7 @@ public class NetcdfStoreProvider extends DataStoreProvider { } /** - * {@return the logger used by netCDF stores}. + * Returns the logger used by netCDF stores. */ @Override public Logger getLogger() { diff --git a/endorsed/src/org.apache.sis.storage.sql/main/org/apache/sis/storage/sql/SQLStoreProvider.java b/endorsed/src/org.apache.sis.storage.sql/main/org/apache/sis/storage/sql/SQLStoreProvider.java index c4495ed214..3f568fa5ed 100644 --- a/endorsed/src/org.apache.sis.storage.sql/main/org/apache/sis/storage/sql/SQLStoreProvider.java +++ b/endorsed/src/org.apache.sis.storage.sql/main/org/apache/sis/storage/sql/SQLStoreProvider.java @@ -238,7 +238,7 @@ public class SQLStoreProvider extends DataStoreProvider { } /** - * {@return the logger used by SQL stores}. + * Returns the logger used by SQL stores. */ @Override public Logger getLogger() { diff --git a/endorsed/src/org.apache.sis.storage.xml/main/org/apache/sis/storage/gpx/StoreProvider.java b/endorsed/src/org.apache.sis.storage.xml/main/org/apache/sis/storage/gpx/StoreProvider.java index 928a4d8f46..edbf8d835b 100644 --- a/endorsed/src/org.apache.sis.storage.xml/main/org/apache/sis/storage/gpx/StoreProvider.java +++ b/endorsed/src/org.apache.sis.storage.xml/main/org/apache/sis/storage/gpx/StoreProvider.java @@ -76,7 +76,7 @@ public final class StoreProvider extends StaxDataStoreProvider { private static final StoreProvider INSTANCE = new StoreProvider(); /** - * {@return the default provider instance}. + * Returns the default provider instance. * This method is invoked by Java service loader. */ public static StoreProvider provider() { @@ -131,7 +131,7 @@ public final class StoreProvider extends StaxDataStoreProvider { } /** - * {@return the logger used by GPX stores}. + * Returns the logger used by <abbr>GPX</abbr> stores. */ @Override public Logger getLogger() { diff --git a/endorsed/src/org.apache.sis.storage.xml/main/org/apache/sis/storage/xml/stream/StaxStreamIO.java b/endorsed/src/org.apache.sis.storage.xml/main/org/apache/sis/storage/xml/stream/StaxStreamIO.java index 949751e852..608f88bcfe 100644 --- a/endorsed/src/org.apache.sis.storage.xml/main/org/apache/sis/storage/xml/stream/StaxStreamIO.java +++ b/endorsed/src/org.apache.sis.storage.xml/main/org/apache/sis/storage/xml/stream/StaxStreamIO.java @@ -102,7 +102,7 @@ abstract class StaxStreamIO implements AutoCloseable { } /** - * {@return the error resources in the current locale}. + * Returns the error resources in the current locale. */ protected final Errors errors() { return Errors.forLocale(owner.getLocale()); diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelData.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelData.java index c8654f4a6b..f1cc23ba6b 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelData.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelData.java @@ -173,9 +173,11 @@ public abstract class ChannelData implements Markable { } /** - * {@return the wrapped channel where data are read or written}. + * Returns the wrapped channel from which data are read or where data are written. * This is the {@code channel} field of the {@code ChannelData} subclass. * + * @return the channel for actual read or write operations. + * * @see ChannelDataInput#channel * @see ChannelDataOutput#channel */ diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelDataInput.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelDataInput.java index 2abd181a59..e2e8ed9dec 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelDataInput.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelDataInput.java @@ -148,9 +148,11 @@ public class ChannelDataInput extends ChannelData implements DataInput { } /** - * {@return the wrapped channel where data are read}. + * Returns the wrapped channel from which the data are read. * This is the {@link #channel} field value. * + * @return the channel from which the data are read. + * * @see #channel */ @Override diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelDataOutput.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelDataOutput.java index 47fddbc323..0c7cc084e0 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelDataOutput.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelDataOutput.java @@ -121,9 +121,11 @@ public class ChannelDataOutput extends ChannelData implements DataOutput, Flusha } /** - * {@return the wrapped channel where data are written}. + * Returns the wrapped channel where data are written. * This is the {@link #channel} field value. * + * @return the channel where data written. + * * @see #channel */ @Override diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelImageOutputStream.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelImageOutputStream.java index 4cb3822cbb..cc3c3a3c2f 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelImageOutputStream.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/ChannelImageOutputStream.java @@ -89,10 +89,11 @@ public class ChannelImageOutputStream extends OutputStream implements ImageOutpu } /** - * {@return the object to use for reading from the stream}. + * Returns the object to use for reading from the stream. * The returned object should not be used anymore after {@link #output()} * has been invoked, until {@code input()} is invoked again. * + * @return helper object to use for reading from the stream. * @throws IOException if an error occurred while flushing a buffer. */ public final ChannelImageInputStream input() throws IOException { @@ -104,10 +105,11 @@ public class ChannelImageOutputStream extends OutputStream implements ImageOutpu } /** - * {@return the object to use for writing to the stream}. + * Returns the object to use for writing to the stream. * The returned object should not be used anymore after {@link #input()} * has been invoked, until {@code output()} is invoked again. * + * @return helper object to use for writing to the stream. * @throws IOException if an error occurred while flushing a buffer. */ public final ChannelDataOutput output() throws IOException { diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/HyperRectangleWriter.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/HyperRectangleWriter.java index 30f001d47d..113d9234bb 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/HyperRectangleWriter.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/HyperRectangleWriter.java @@ -501,34 +501,42 @@ public class HyperRectangleWriter { } /** - * {@return the number of banks to write}. + * Returns the number of banks to write. * This is not necessarily the number of bands, because the writer may be able * to write all bands contiguously in a single call to a {@code write(…)} method. + * + * @return the number of banks (not bands) to write. */ public int numBanks() { return bankIndices.length; } /** - * {@return the total number of elements contained in the hyper-rectangle}. + * Returns the total number of elements contained in the hyper-rectangle. * The number of bytes to write will be this length multiplied by element size. * This information is valid only after a {@code create(…)} method has been invoked. + * + * @return the total number of elements contained in the hyper-rectangle. */ public long length() { return length; } /** - * {@return the number of elements (not necessarily bytes) between a pixel and the next pixel}. + * Returns the number of elements (not necessarily bytes) between a pixel and the next pixel. * This information is valid only after a {@code create(…)} method has been invoked. + * + * @return number of elements between a pixel and the next pixel. */ public int pixelStride() { return pixelStride; } /** - * {@return the number of elements (not necessarily bytes) between a row and the next row}. + * Returns the number of elements (not necessarily bytes) between a row and the next row. * This information is valid only after a {@code create(…)} method has been invoked. + * + * @return number of elements between a row and the next row. */ public int scanlineStride() { return scanlineStride; diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/Region.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/Region.java index a7cc2bd32a..5d1da03a63 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/Region.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/Region.java @@ -231,7 +231,7 @@ public final class Region { } /** - * {@return the number of values to skip after having read values in the given dimension}. + * Returns the number of values to skip after having read values in the given dimension. */ final long getSkip(final int dimension) { return skips[dimension]; diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/UpdatableWrite.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/UpdatableWrite.java index 8f3a1d0892..e62bcbccd2 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/UpdatableWrite.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/io/stream/UpdatableWrite.java @@ -237,13 +237,13 @@ public abstract class UpdatableWrite<V> implements CheckedContainer<V> { } /** - * {@return the value size in number of bytes}. + * Returns the value size in number of bytes. * This is used for checking if there is enough room in a buffer. */ abstract int sizeInBytes(); /** - * {@return whether the value changed since it has been written}. + * Returns whether the value changed since it has been written. * This is used for avoiding unnecessary write operations in the output. */ abstract boolean changed(); @@ -268,7 +268,7 @@ public abstract class UpdatableWrite<V> implements CheckedContainer<V> { public abstract void set(V value); /** - * {@return the same value as {@code get()}, but as a 64-bits integer}. + * Returns the same value as {@code get()}, but as a 64-bits integer. * This method is useful when the parameterized type is {@code <?>}. */ public abstract OptionalLong getAsLong(); diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/PRJDataStore.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/PRJDataStore.java index 103260aff2..d7239a84bc 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/PRJDataStore.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/PRJDataStore.java @@ -98,11 +98,13 @@ public abstract class PRJDataStore extends URIDataStore { } /** - * {@return the convention to use for parsing the PRJ file if Well-Known Text 1 is used}. + * Returns the convention to use for parsing the <abbr>PRJ</abbr> file if Well-Known Text 1 is used. * Unfortunately, many formats use the ambiguous conventions from the very first specification, * and ignore the clarifications done by OGC 01-009. In such case, we have to tell the WKT parser * that the ambiguous conventions are used. This method can be overridden if the subclass has a way * to know which WKT 1 conventions are used. + * + * @return convention to use for parsing the <abbr>PRJ</abbr> file. */ protected Convention getConvention() { return Convention.WKT1_COMMON_UNITS; diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/SimpleAggregate.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/SimpleAggregate.java index 697c214a61..4e9fb0bd04 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/SimpleAggregate.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/SimpleAggregate.java @@ -47,7 +47,7 @@ final class SimpleAggregate extends AbstractResource implements Aggregate { } /** - * {@return the components of this aggregate}. + * Returns the components of this aggregate. */ @Override @SuppressWarnings("ReturnOfCollectionOrArrayField") diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/URIDataStore.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/URIDataStore.java index f07b2efd9a..0870fff38a 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/URIDataStore.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/URIDataStore.java @@ -156,7 +156,7 @@ public abstract class URIDataStore extends DataStore implements StoreResource { } /** - * {@return the filename without path and without file extension, or null if none}. + * Returns the filename without path and without file extension, or {@code null} if none. * This method can be used for building metadata like below (note that {@link #getIdentifier()} * should not be invoked during metadata construction time, for avoiding recursive method calls): * @@ -167,6 +167,8 @@ public abstract class URIDataStore extends DataStore implements StoreResource { * Above snippet should not be applied before this data store did its best effort for providing a title. * The use of identifier as a title is a fallback for making valid metadata, because the title is mandatory * in ISO 19111 metadata. + * + * @return filename without path and without file extension, or {@code null}. */ public final String getFilename() { if (location == null) { @@ -280,9 +282,11 @@ public abstract class URIDataStore extends DataStore implements StoreResource { } /** - * {@return the path to the auxiliary metadata file, or null if none}. + * Returns the path to the auxiliary metadata file, or {@code null} if none. * This is a path built from the {@link DataOptionKey#METADATA_PATH} value if present. * Note that the metadata may be unavailable as a {@link Path} but available as an {@link URI}. + * + * @return the path to the auxiliary metadata file, or {@code null} if none. */ private Path getMetadataPath() throws IOException { Path path = replaceWildcard(metadataPath); @@ -302,9 +306,11 @@ public abstract class URIDataStore extends DataStore implements StoreResource { } /** - * {@return the URI to the auxiliary metadata file, or null if none}. + * Returns the <abbr>URI</abbr> to the auxiliary metadata file, or {@code null} if none. * This is a path built from the {@link DataOptionKey#METADATA_PATH} value if present. * Note that the metadata may be unavailable as an {@link URI} but available as a {@link Path}. + * + * @return the <abbr>URI</abbr> to the auxiliary metadata file, or {@code null} if none. */ private URI getMetadataURI() throws URISyntaxException { URI uri = location; @@ -541,9 +547,10 @@ public abstract class URIDataStore extends DataStore implements StoreResource { } /** - * {@return the error message for saying that an auxiliary file cannot be read}. + * Returns the error message for saying that an auxiliary file cannot be read. * * @param extension file extension (without leading dot) of the auxiliary file, or null for the main file. + * @return error message for saying that an auxiliary file cannot be read. */ protected final String cannotReadAuxiliaryFile(final String extension) { if (extension == null) { diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/WritableAggregateSupport.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/WritableAggregateSupport.java index 2752231cee..88944943f3 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/WritableAggregateSupport.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/WritableAggregateSupport.java @@ -55,7 +55,9 @@ public final class WritableAggregateSupport implements Localized { } /** - * {@return the locale used by the targetresource for error messages, or {@code null} if unknown}. + * Returns the locale used by the target resource for error messages, or {@code null} if unknown. + * + * @return locale for error messages, or {@code null} if unknown. */ @Override public final Locale getLocale() { diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/WritableGridCoverageSupport.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/WritableGridCoverageSupport.java index c9d27905c9..ce20e71098 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/WritableGridCoverageSupport.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/WritableGridCoverageSupport.java @@ -90,7 +90,9 @@ public final class WritableGridCoverageSupport implements Localized { } /** - * {@return the locale used by the target resource for error messages, or {@code null} if unknown}. + * Returns the locale used by the target resource for error messages, or {@code null} if unknown. + * + * @return locale for error messages, or {@code null} if unknown. */ @Override public final Locale getLocale() { diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/csv/StoreProvider.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/csv/StoreProvider.java index 492e9bd874..4cdda19ab5 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/csv/StoreProvider.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/csv/StoreProvider.java @@ -199,7 +199,7 @@ public final class StoreProvider extends URIDataStoreProvider { } /** - * {@return the logger used by CSV stores}. + * Returns the logger used by <abbr>CSV</abbr> stores. */ @Override public Logger getLogger() { diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/esri/AsciiGridStoreProvider.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/esri/AsciiGridStoreProvider.java index 65a5791c12..e0120b0c18 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/esri/AsciiGridStoreProvider.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/esri/AsciiGridStoreProvider.java @@ -143,7 +143,7 @@ cellsize: if (!header.containsKey(AsciiGridStore.CELLSIZE)) { } /** - * {@return the logger used by ASCII grid stores}. + * Returns the logger used by ASCII grid stores. */ @Override public Logger getLogger() { diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/esri/RawRasterStoreProvider.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/esri/RawRasterStoreProvider.java index f46423d2dc..78d912fa71 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/esri/RawRasterStoreProvider.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/esri/RawRasterStoreProvider.java @@ -120,7 +120,7 @@ public final class RawRasterStoreProvider extends PRJDataStore.Provider { } /** - * {@return the logger used by RAW stores}. + * Returns the logger used by RAW stores. */ @Override public Logger getLogger() { diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/folder/StoreProvider.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/folder/StoreProvider.java index d6534556e0..a5c95abfc3 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/folder/StoreProvider.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/folder/StoreProvider.java @@ -287,7 +287,7 @@ public final class StoreProvider extends DataStoreProvider { } /** - * {@return the logger used by folder stores}. + * Returns the logger used by folder stores. */ @Override public Logger getLogger() { diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/image/WorldFileStoreProvider.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/image/WorldFileStoreProvider.java index 8d4a8a9cab..fd8e0463db 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/image/WorldFileStoreProvider.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/image/WorldFileStoreProvider.java @@ -175,7 +175,7 @@ public final class WorldFileStoreProvider extends PRJDataStore.Provider { } /** - * {@return the logger used by image stores}. + * Returns the logger used by image stores. */ @Override public Logger getLogger() { diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/wkt/StoreProvider.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/wkt/StoreProvider.java index cda35ab2d1..1ca162c9c5 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/wkt/StoreProvider.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/wkt/StoreProvider.java @@ -192,7 +192,7 @@ public final class StoreProvider extends URIDataStoreProvider { } /** - * {@return the logger used by WKT stores}. + * Returns the logger used by <abbr>WKT</abbr> stores. */ @Override public Logger getLogger() { diff --git a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/xml/StoreProvider.java b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/xml/StoreProvider.java index 93747e71ab..d3f522ca27 100644 --- a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/xml/StoreProvider.java +++ b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/xml/StoreProvider.java @@ -91,7 +91,7 @@ public final class StoreProvider extends AbstractProvider { } /** - * {@return the logger used by XML stores}. + * Returns the logger used by <abbr>XML</abbr> stores. */ @Override public Logger getLogger() { diff --git a/endorsed/src/org.apache.sis.storage/test/org/apache/sis/io/stream/ByteArrayChannel.java b/endorsed/src/org.apache.sis.storage/test/org/apache/sis/io/stream/ByteArrayChannel.java index 322eb53cc7..836572e7a9 100644 --- a/endorsed/src/org.apache.sis.storage/test/org/apache/sis/io/stream/ByteArrayChannel.java +++ b/endorsed/src/org.apache.sis.storage/test/org/apache/sis/io/stream/ByteArrayChannel.java @@ -123,7 +123,7 @@ public final class ByteArrayChannel implements SeekableByteChannel { } /** - * {@return this channel position}. + * Returns this channel position. * * @throws IOException if the channel is closed. */ @@ -148,7 +148,7 @@ public final class ByteArrayChannel implements SeekableByteChannel { } /** - * {@return the current size}. + * Returns the current size. * * @throws IOException if the channel is closed. */ @@ -182,7 +182,7 @@ public final class ByteArrayChannel implements SeekableByteChannel { } /** - * {@return whether or not this channel is open}. + * Returns whether or not this channel is open. */ @Override public boolean isOpen() { diff --git a/endorsed/src/org.apache.sis.storage/test/org/apache/sis/io/stream/ChannelDataTestCase.java b/endorsed/src/org.apache.sis.storage/test/org/apache/sis/io/stream/ChannelDataTestCase.java index da3a3625ea..a795414350 100644 --- a/endorsed/src/org.apache.sis.storage/test/org/apache/sis/io/stream/ChannelDataTestCase.java +++ b/endorsed/src/org.apache.sis.storage/test/org/apache/sis/io/stream/ChannelDataTestCase.java @@ -149,49 +149,49 @@ abstract class ChannelDataTestCase extends TestCase { return array; } - /** {@return a new array of bytes or random length}. */ + /** Returns a new array of bytes or random length. */ final byte[] randomBytes() { final byte[] array = new byte[random.nextInt(ARRAY_MAX_LENGTH / Byte.BYTES)]; random.nextBytes(array); return array; } - /** {@return a new array of characters or random length}. */ + /** Returns a new array of characters or random length. */ final char[] randomChars() { final char[] array = new char[random.nextInt(ARRAY_MAX_LENGTH / Character.BYTES)]; for (int i=0; i<array.length; i++) array[i] = (char) random.nextInt(1 << Character.SIZE); return array; } - /** {@return a new array of short integers or random length}. */ + /** Returns a new array of short integers or random length. */ final short[] randomShorts() { final short[] array = new short[random.nextInt(ARRAY_MAX_LENGTH / Short.BYTES)]; for (int i=0; i<array.length; i++) array[i] = (short) random.nextInt(1 << Short.SIZE); return array; } - /** {@return a new array of integers or random length}. */ + /** Returns a new array of integers or random length. */ final int[] randomInts() { final int[] array = new int[random.nextInt(ARRAY_MAX_LENGTH / Integer.BYTES)]; for (int i=0; i<array.length; i++) array[i] = random.nextInt(); return array; } - /** {@return a new array of long integers or random length}. */ + /** Returns a new array of long integers or random length. */ final long[] randomLongs() { final long[] array = new long[random.nextInt(ARRAY_MAX_LENGTH / Long.BYTES)]; for (int i=0; i<array.length; i++) array[i] = random.nextLong(); return array; } - /** {@return a new array of single-precision floating point values or random length}. */ + /** Returns a new array of single-precision floating point values or random length. */ final float[] randomFloats() { final float[] array = new float[random.nextInt(ARRAY_MAX_LENGTH / Float.BYTES)]; for (int i=0; i<array.length; i++) array[i] = random.nextFloat(); return array; } - /** {@return a new array of double-precision floating point values or random length}. */ + /** Returns a new array of double-precision floating point values or random length. */ final double[] randomDoubles() { final double[] array = new double[random.nextInt(ARRAY_MAX_LENGTH / Double.BYTES)]; for (int i=0; i<array.length; i++) array[i] = random.nextDouble(); diff --git a/endorsed/src/org.apache.sis.util/main/org/apache/sis/measure/UnitDimension.java b/endorsed/src/org.apache.sis.util/main/org/apache/sis/measure/UnitDimension.java index 16f8f00bdf..af003b24bf 100644 --- a/endorsed/src/org.apache.sis.util/main/org/apache/sis/measure/UnitDimension.java +++ b/endorsed/src/org.apache.sis.util/main/org/apache/sis/measure/UnitDimension.java @@ -405,7 +405,7 @@ final class UnitDimension implements Dimension, Serializable { } /** - * {@return returns a hash code value which takes element order in account}. + * Returns returns a hash code value which takes element order in account. * If the map is empty or contains only one element, then the returned value * is the same as {@link #hashCode()}. */ @@ -416,9 +416,10 @@ final class UnitDimension implements Dimension, Serializable { } /** - * {@return an hash code value of the given map computed in an order-sensitive was}. + * Returns an hash code value of the given map computed in an order-sensitive was. * * @param components the map for which to compute hash code. + * @return order-sensitive hash code value for the given components. */ static int hashCodeOrdered(final Map<?,?> components) { int code = 0; diff --git a/endorsed/src/org.apache.sis.util/main/org/apache/sis/pending/jdk/HexFormat.java b/endorsed/src/org.apache.sis.util/main/org/apache/sis/pending/jdk/HexFormat.java index 74f198038a..a5cc19f3cc 100644 --- a/endorsed/src/org.apache.sis.util/main/org/apache/sis/pending/jdk/HexFormat.java +++ b/endorsed/src/org.apache.sis.util/main/org/apache/sis/pending/jdk/HexFormat.java @@ -31,7 +31,7 @@ public final class HexFormat { } /** - * {@return the singleton instance}. + * Returns the singleton instance. */ public static HexFormat of() { return INSTANCE; @@ -57,7 +57,7 @@ public final class HexFormat { } /** - * {@return the numerical value of the given hexadecimal digit}. + * Returns the numerical value of the given hexadecimal digit. * The hexadecimal digit can be the decimal digits 0 to 9, or the letters A to F ignoring case. * * <h4>Implementation note</h4> @@ -65,6 +65,7 @@ public final class HexFormat { * range of Unicode characters, which is a wider scope than what is intended here. * * @param c the hexadecimal digit. + * @return numerical value of the given hexadecimal digit. * @throws NumberFormatException if the given character is not a hexadecimal digit. */ public static int fromHexDigit(final int c) { diff --git a/endorsed/src/org.apache.sis.util/main/org/apache/sis/pending/jdk/JDK17.java b/endorsed/src/org.apache.sis.util/main/org/apache/sis/pending/jdk/JDK17.java index c1ccbe0a06..e9cbb105c5 100644 --- a/endorsed/src/org.apache.sis.util/main/org/apache/sis/pending/jdk/JDK17.java +++ b/endorsed/src/org.apache.sis.util/main/org/apache/sis/pending/jdk/JDK17.java @@ -33,7 +33,7 @@ public final class JDK17 { } /** - * {@return a placeholder for the character set of the console}. + * Returns a placeholder for the character set of the console. * * @param console the console for which to get the character set. */ diff --git a/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/shared/DoubleDouble.java b/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/shared/DoubleDouble.java index 4c29b5c90d..39105bb80e 100644 --- a/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/shared/DoubleDouble.java +++ b/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/shared/DoubleDouble.java @@ -437,14 +437,18 @@ public final class DoubleDouble extends Number implements Comparable<DoubleDoubl } /** - * {@return {@code 1/this}}. + * Returns {@code 1/this}. + * + * @return a new number which is the inverse of this number. */ public DoubleDouble inverse() { return ONE.divide(this); } /** - * {@return {@code -this}}. + * Returns {@code -this}. + * + * @return a new number which is the negative of this number. */ public DoubleDouble negate() { return new DoubleDouble(-value, -error); diff --git a/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/logging/MonolineFormatter.java b/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/logging/MonolineFormatter.java index da5eeeb935..f6f6d83b35 100644 --- a/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/logging/MonolineFormatter.java +++ b/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/logging/MonolineFormatter.java @@ -645,11 +645,13 @@ loop: for (int i=0; ; i++) { } /** - * {@return the provider of the maximal number of columns in the records to format, or {@code null} if none}. + * Returns the provider of the maximal number of columns in the records to format, or {@code null} if none. * Records longer than this value (in number of Unicode code points) will be separated one two or more lines. * The value may be a constant, or it may be a value fetched from the {@code COLUMNS} environment variable. * Advanced applications may also try to get this value by executing an OS-specific command. * + * @return maximal number of columns in the records to format, or {@code null} if none. + * * @since 1.5 */ public IntSupplier getMaximalLineLength() { diff --git a/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/CoverageJsonStoreProvider.java b/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/CoverageJsonStoreProvider.java index e4ab613434..cbfca0a647 100644 --- a/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/CoverageJsonStoreProvider.java +++ b/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/CoverageJsonStoreProvider.java @@ -96,7 +96,7 @@ public class CoverageJsonStoreProvider extends DataStoreProvider { } /** - * {@return the logger used by CoverageJSON stores}. + * Returns the logger used by CoverageJSON stores. */ @Override public Logger getLogger() {
