You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sis.apache.org by de...@apache.org on 2023/02/10 22:32:33 UTC
[sis] 03/03: Documentation fixes.
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 f22ff357a702edef722158762c1c2537543d4805
Author: Martin Desruisseaux <ma...@geomatys.com>
AuthorDate: Fri Feb 10 17:31:35 2023 +0100
Documentation fixes.
---
.../src/main/java/org/apache/sis/internal/referencing/j2d/Tile.java | 5 ++++-
.../java/org/apache/sis/internal/referencing/j2d/TileOrganizer.java | 5 ++++-
.../src/main/java/org/apache/sis/referencing/GeodeticCalculator.java | 4 ----
.../src/main/java/org/apache/sis/util/collection/Cache.java | 2 +-
.../main/java/org/apache/sis/storage/aggregate/MergeStrategy.java | 2 +-
.../src/main/java/org/apache/sis/storage/tiling/TileMatrixSet.java | 1 +
6 files changed, 11 insertions(+), 8 deletions(-)
diff --git a/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/j2d/Tile.java b/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/j2d/Tile.java
index a34360e7c5..2cd2ecd387 100644
--- a/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/j2d/Tile.java
+++ b/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/j2d/Tile.java
@@ -101,7 +101,10 @@ import org.apache.sis.io.TableAppender;
*
* @author Martin Desruisseaux (Geomatys)
* @version 1.1
- * @since 1.1
+ *
+ * @see org.apache.sis.storage.tiling.Tile
+ *
+ * @since 1.1
*/
public class Tile implements Serializable {
/**
diff --git a/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/j2d/TileOrganizer.java b/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/j2d/TileOrganizer.java
index c9eafc9ba1..118183ba17 100644
--- a/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/j2d/TileOrganizer.java
+++ b/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/j2d/TileOrganizer.java
@@ -47,7 +47,10 @@ import org.apache.sis.referencing.operation.matrix.AffineTransforms2D;
*
* @author Martin Desruisseaux (Geomatys)
* @version 1.1
- * @since 1.1
+ *
+ * @see org.apache.sis.storage.aggregate.CoverageAggregator
+ *
+ * @since 1.1
*/
public class TileOrganizer {
/**
diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/GeodeticCalculator.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/GeodeticCalculator.java
index a8079e6db2..26e102c231 100644
--- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/GeodeticCalculator.java
+++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/GeodeticCalculator.java
@@ -292,10 +292,6 @@ public class GeodeticCalculator {
* or return value will use that specified CRS.
* That CRS is the value returned by {@link #getPositionCRS()}.
*
- * <h4>Limitations</h4>
- * Current implementation uses only spherical formulas.
- * Implementation using ellipsoidal formulas will be provided in a future Apache SIS release.
- *
* @param crs the reference system for the {@link Position} objects.
* @return a new geodetic calculator using the specified CRS.
*/
diff --git a/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java b/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java
index 40daebdb49..01c31256c1 100644
--- a/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java
+++ b/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java
@@ -209,7 +209,7 @@ public class Cache<K,V> extends AbstractMap<K,V> implements ConcurrentMap<K,V> {
* {@linkplain Reference weak or soft references}.</p>
*
* @param initialCapacity the initial capacity.
- * @param costLimit the maximum cost of objects to keep by strong reference.
+ * @param costLimit the maximum cost (inclusive) of objects to keep by strong reference.
* @param soft if {@code true}, use {@link SoftReference} instead of {@link WeakReference}.
*/
public Cache(int initialCapacity, final long costLimit, final boolean soft) {
diff --git a/storage/sis-storage/src/main/java/org/apache/sis/storage/aggregate/MergeStrategy.java b/storage/sis-storage/src/main/java/org/apache/sis/storage/aggregate/MergeStrategy.java
index 56aea2da9c..5cf4702cde 100644
--- a/storage/sis-storage/src/main/java/org/apache/sis/storage/aggregate/MergeStrategy.java
+++ b/storage/sis-storage/src/main/java/org/apache/sis/storage/aggregate/MergeStrategy.java
@@ -164,7 +164,7 @@ public final class MergeStrategy {
* @param resource the resource for which to update the merge strategy, or {@code null}.
* @return resource with updated merge strategy, or {@code null} if the given resource was null.
*/
- public Resource apply(Resource resource) {
+ public Resource apply(final Resource resource) {
if (resource instanceof AggregatedResource) {
return ((AggregatedResource) resource).apply(this);
}
diff --git a/storage/sis-storage/src/main/java/org/apache/sis/storage/tiling/TileMatrixSet.java b/storage/sis-storage/src/main/java/org/apache/sis/storage/tiling/TileMatrixSet.java
index 22bd07fe1f..9be260b712 100644
--- a/storage/sis-storage/src/main/java/org/apache/sis/storage/tiling/TileMatrixSet.java
+++ b/storage/sis-storage/src/main/java/org/apache/sis/storage/tiling/TileMatrixSet.java
@@ -83,6 +83,7 @@ public interface TileMatrixSet {
* For each value in the map, the associated key is {@link TileMatrix#getIdentifier()}.
* Entries are sorted from coarser resolution (highest scale denominator) to most detailed
* resolution (lowest scale denominator).
+ * This is not necessarily the natural ordering of the {@link GenericName} instances used as keys.
*
* @return unmodifiable collection of all {@code TileMatrix} instances with their identifiers.
*/