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 cbff3dd11d6908b4d3116e62463a39152c9dd3fe
Author: Martin Desruisseaux <martin.desruisse...@geomatys.com>
AuthorDate: Fri Aug 25 17:23:12 2023 +0200
Minor documentation updates.
---
.../main/org/apache/sis/feature/PropertyView.java | 2 +-
.../sis/metadata/simple/SimpleIdentifiedObject.java | 4 ++--
.../main/org/apache/sis/xml/bind/gco/package-info.java | 2 +-
.../main/org/apache/sis/xml/bind/lan/LanguageCode.java | 4 ++--
.../main/org/apache/sis/openoffice/CalcAddins.java | 2 +-
.../main/org/apache/sis/parameter/Verifier.java | 2 +-
.../main/org/apache/sis/referencing/CommonCRS.java | 16 +++++++++-------
.../sis/referencing/factory/CommonAuthorityCode.java | 2 +-
.../referencing/operation/matrix/AffineTransforms2D.java | 2 +-
.../operation/transform/ConcatenatedTransform.java | 2 +-
.../org.apache.sis.test.endorsed/test/module-info.java | 1 +
.../org/apache/sis/util/collection/CacheEntries.java | 4 ++--
.../org/apache/sis/util/internal/CollectionsExt.java | 12 ++++++------
13 files changed, 29 insertions(+), 26 deletions(-)
diff --git
a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/feature/PropertyView.java
b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/feature/PropertyView.java
index d7fb39cd8f..301de380ed 100644
---
a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/feature/PropertyView.java
+++
b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/feature/PropertyView.java
@@ -143,7 +143,7 @@ abstract class PropertyView<V> extends Field<V> implements
Property, Serializabl
* Returns the given value as a singleton if non-null, or returns an empty
list otherwise.
*
* @param <V> the element type.
- * @param element the element to returns in a collection if non-null.
+ * @param element the element to return in a collection if non-null.
* @return a collection containing the given element if non-null, or an
empty collection otherwise.
*/
static <V> List<V> singletonOrEmpty(final V element) {
diff --git
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/simple/SimpleIdentifiedObject.java
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/simple/SimpleIdentifiedObject.java
index 7552b72860..ba0a000168 100644
---
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/simple/SimpleIdentifiedObject.java
+++
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/metadata/simple/SimpleIdentifiedObject.java
@@ -93,7 +93,7 @@ public class SimpleIdentifiedObject implements
IdentifiedObject, LenientComparab
* Method required by most {@link IdentifiedObject} sub-interfaces.
* Current implementation returns {@code null}.
*
- * <p>If a future version allows this method to returns a non-null value,
+ * <p>If a future version allows this method to return a non-null value,
* revisit {@link #equals(Object, ComparisonMode)} in subclasses.</p>
*
* @return the domain of validity, or {@code null} if none.
@@ -106,7 +106,7 @@ public class SimpleIdentifiedObject implements
IdentifiedObject, LenientComparab
* Method required by most {@link IdentifiedObject} sub-interfaces.
* Current implementation returns {@code null}.
*
- * <p>If a future version allows this method to returns a non-null value,
+ * <p>If a future version allows this method to return a non-null value,
* revisit {@link #equals(Object, ComparisonMode)} in subclasses.</p>
*
* @return the scope, or {@code null} if none.
diff --git
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/gco/package-info.java
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/gco/package-info.java
index ae2d1e1918..2790c17d37 100644
---
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/gco/package-info.java
+++
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/gco/package-info.java
@@ -55,7 +55,7 @@
* <li>Contains the {@code gco:ObjectIdentification} group of attributes
({@code id}, {@code uuid}).</li>
* <li>Conceptually could have been subclasses of {@code
ObjectIdentification} defined in this package.</li>
* </ul></li>
- * <li><code>org.apache.sis.<b>internal.jaxb</b></code> private packages:
+ * <li><code>org.apache.sis.<b>xml.bind</b></code> private packages:
* <ul>
* <li>Implement the ISO 19115-3 {@code Foo_PropertyType} as subclasses of
the {@link org.apache.sis.xml.bind.gco.PropertyType} class.</li>
* <li>Contains the {@code gco:ObjectReference} group of attributes
({@code xlink}, {@code uuidref}).</li>
diff --git
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/lan/LanguageCode.java
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/lan/LanguageCode.java
index 3956d8100e..7a7202c851 100644
---
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/lan/LanguageCode.java
+++
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/lan/LanguageCode.java
@@ -153,14 +153,14 @@ public final class LanguageCode extends
GO_CharacterString {
* <gmd:LanguageCode codeList="(snip)#LanguageCode"
codeListValue="jpn">Japanese</gmd:LanguageCode>
* </gmd:language>
*/
- code = identifier.toString(); // May still be null.
+ code = identifier.toString(); // May still be null.
} else {
/*
* <gmd:language>
* <gco:CharacterString>jpn</gco:CharacterString>
* </gmd:language>
*/
- code = toString(); // May still be null.
+ code = toString(); // May still be null.
}
/*
* Do not trim whitespaces. We leave that decision to ValueConverter.
diff --git
a/endorsed/src/org.apache.sis.openoffice/main/org/apache/sis/openoffice/CalcAddins.java
b/endorsed/src/org.apache.sis.openoffice/main/org/apache/sis/openoffice/CalcAddins.java
index 8fba9627ca..e73d26dfc6 100644
---
a/endorsed/src/org.apache.sis.openoffice/main/org/apache/sis/openoffice/CalcAddins.java
+++
b/endorsed/src/org.apache.sis.openoffice/main/org/apache/sis/openoffice/CalcAddins.java
@@ -142,7 +142,7 @@ public abstract class CalcAddins extends WeakBase
implements XServiceName, XServ
}
/**
- * The string to returns when a formula does not have any value to return.
+ * The string to return when a formula does not have any value to return.
*
* @return the string with a message for missing values.
*/
diff --git
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/parameter/Verifier.java
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/parameter/Verifier.java
index a7c929c0c9..ffddfbb7ca 100644
---
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/parameter/Verifier.java
+++
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/parameter/Verifier.java
@@ -367,7 +367,7 @@ final class Verifier {
/**
* Convenience method returning the name of the specified descriptor.
* This method is used mostly for output to be read by human, not for
processing.
- * Consequently, we may consider to returns a localized name in a future
version.
+ * Consequently, we may consider to return a localized name in a future
version.
*
* <p>This method is null-safe even if none of the references checked here
should be null.
* We make this method safe because it is indirectly invoked by methods
like {@code toString()}
diff --git
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/CommonCRS.java
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/CommonCRS.java
index b26837df19..0ae6a621a3 100644
---
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/CommonCRS.java
+++
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/CommonCRS.java
@@ -52,6 +52,7 @@ import org.opengis.referencing.datum.VerticalDatum;
import org.opengis.referencing.datum.VerticalDatumType;
import org.opengis.referencing.datum.TemporalDatum;
import org.opengis.referencing.datum.EngineeringDatum;
+import org.opengis.metadata.extent.GeographicBoundingBox;
import org.apache.sis.referencing.datum.DefaultVerticalDatum;
import org.apache.sis.referencing.datum.DefaultTemporalDatum;
import org.apache.sis.referencing.datum.DefaultEngineeringDatum;
@@ -535,6 +536,8 @@ public enum CommonCRS {
/**
* Returns the default two-dimensional normalized geographic CRS.
+ * This CRS is okay for <em>computational purposes</em> but should
+ * not be used for showing coordinates in graphical user interfaces.
* The CRS returned by this method has the following properties:
*
* <ul>
@@ -544,15 +547,14 @@ public enum CommonCRS {
* <li>Prime meridian in Greenwich.</li>
* </ul>
*
- * <div class="note"><b>Note:</b>
+ * <h4>Default reference frame</h4>
* This method makes no guarantees about the datum. The current default
datum is WGS 84,
- * but this may change in future SIS versions if a WGS 84 replacement
become in wide use.</div>
+ * but this may change or become configurable in any future SIS versions.
*
- * This default CRS is assigned to
- * {@linkplain
org.apache.sis.geometry.GeneralEnvelope#GeneralEnvelope(org.opengis.metadata.extent.GeographicBoundingBox)
- * envelopes created from a geographic bounding box}.
- * Since ISO 19115 {@link
org.opengis.metadata.extent.GeographicBoundingBox} is approximated by
definition,
- * their datum can be arbitrary.
+ * <p>This default CRS is assigned to
+ * {@linkplain
org.apache.sis.geometry.GeneralEnvelope#GeneralEnvelope(GeographicBoundingBox)
envelopes created
+ * from a geographic bounding box}. Since ISO 19115 {@link
GeographicBoundingBox} is approximated by definition,
+ * their datum can be arbitrary.</p>
*
* @return the default two-dimensional geographic CRS with
(<var>longitude</var>, <var>latitude</var>) axis order.
*/
diff --git
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/CommonAuthorityCode.java
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/CommonAuthorityCode.java
index 88ddf4e0c0..88c0efd968 100644
---
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/CommonAuthorityCode.java
+++
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/CommonAuthorityCode.java
@@ -127,7 +127,7 @@ final class CommonAuthorityCode {
/**
* Returns whether the authority is "AUTO", "AUTO1" or "AUTO2".
*
- * @param legacy whether to returns {@code true} only if the authority
is "AUTO" or "AUTO1".
+ * @param legacy whether to return {@code true} only if the authority is
"AUTO" or "AUTO1".
* @return whether the authority is some "AUTO" namespace.
*/
final boolean isAuto(final boolean legacy) {
diff --git
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/matrix/AffineTransforms2D.java
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/matrix/AffineTransforms2D.java
index 0377f8347f..cca85c04e6 100644
---
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/matrix/AffineTransforms2D.java
+++
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/matrix/AffineTransforms2D.java
@@ -77,7 +77,7 @@ public final class AffineTransforms2D extends Static {
* If the given matrix is already an instance of {@link AffineTransform},
then it is returned directly.
* Otherwise the values are copied in a new {@code AffineTransform}
instance.
*
- * @param matrix the matrix to returns as an affine transform, or {@code
null}.
+ * @param matrix the matrix to return as an affine transform, or {@code
null}.
* @return the matrix argument if it can be safely casted (including
{@code null} argument),
* or a copy of the given matrix otherwise.
* @throws IllegalArgumentException if the given matrix size is not 3×3 or
if the matrix is not affine.
diff --git
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/transform/ConcatenatedTransform.java
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/transform/ConcatenatedTransform.java
index d37e4f9912..e2d186cf40 100644
---
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/transform/ConcatenatedTransform.java
+++
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/transform/ConcatenatedTransform.java
@@ -186,7 +186,7 @@ class ConcatenatedTransform extends AbstractMathTransform
implements Serializabl
}
/**
- * Tries to returns an optimized concatenation, for example by merging two
affine transforms
+ * Tries to return an optimized concatenation, for example by merging two
affine transforms
* into a single one. If no optimized case has been found, returns {@code
null}. In the latter
* case, the caller will need to create a more heavy {@link
ConcatenatedTransform} instance.
*
diff --git a/endorsed/src/org.apache.sis.test.endorsed/test/module-info.java
b/endorsed/src/org.apache.sis.test.endorsed/test/module-info.java
index b5ef65a6f1..5530caf16d 100644
--- a/endorsed/src/org.apache.sis.test.endorsed/test/module-info.java
+++ b/endorsed/src/org.apache.sis.test.endorsed/test/module-info.java
@@ -23,6 +23,7 @@
* @since 1.4
*/
module org.apache.sis.test.endorsed {
+ requires transitive junit;
requires transitive org.opengis.geoapi.conformance;
requires transitive org.apache.derby.tools;
requires transitive org.hsqldb;
diff --git
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/collection/CacheEntries.java
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/collection/CacheEntries.java
index 0dc516a3a1..3fb830c8ce 100644
---
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/collection/CacheEntries.java
+++
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/collection/CacheEntries.java
@@ -94,7 +94,7 @@ final class CacheEntries<K,V> extends
AbstractSet<Map.Entry<K,V>> {
private final Iterator<Map.Entry<K,Object>> it;
/**
- * The next entry to returns, or {@code null} if we reached the end of
iteration.
+ * The next entry to return, or {@code null} if we reached the end of
iteration.
*/
private Map.Entry<K,V> next;
@@ -130,7 +130,7 @@ final class CacheEntries<K,V> extends
AbstractSet<Map.Entry<K,V>> {
}
/**
- * Returns {@code true} if there is more element to returns.
+ * Returns {@code true} if there is more elements to return.
*/
@Override
public boolean hasNext() {
diff --git
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/CollectionsExt.java
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/CollectionsExt.java
index 54b78f5f31..638cf0f502 100644
---
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/CollectionsExt.java
+++
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/CollectionsExt.java
@@ -181,7 +181,7 @@ public final class CollectionsExt extends Static {
* Returns the given value as a singleton if non-null, or returns an empty
set otherwise.
*
* @param <E> the element type.
- * @param element the element to returns in a collection if non-null.
+ * @param element the element to return in a collection if non-null.
* @return a collection containing the given element if non-null, or an
empty collection otherwise.
*/
public static <E> Set<E> singletonOrEmpty(final E element) {
@@ -340,7 +340,7 @@ public final class CollectionsExt extends Static {
* values will be included in the returned set.
*
* <p>This method differs from {@link Set#of(Object...)} in that it
preserves element order
- * and optionally accepts null elements.</p>
+ * and accepts null elements.</p>
*
* @param <E> the type of array elements.
* @param excludeNull {@code true} for excluding the {@code null}
element from the returned set.
@@ -380,7 +380,7 @@ public final class CollectionsExt extends Static {
/**
* Returns a unmodifiable version of the given set.
* This method is different than the standard {@link
Collections#unmodifiableSet(Set)}
- * in that it tries to returns a more efficient object when there is zero
or one element.
+ * in that it tries to return a more efficient object when there is zero
or one element.
* Such small set occurs frequently in Apache SIS, especially for
* {@link org.apache.sis.referencing.AbstractIdentifiedObject} names or
identifiers.
*
@@ -390,7 +390,7 @@ public final class CollectionsExt extends Static {
* standard {@link Collections#unmodifiableSet(Set)} method instead.</p>
*
* <p>This method differs from {@link Set#copyOf(Collection)} in that it
may avoid copy,
- * preserves element order and optionally null elements.</p>
+ * preserves element order and accepts null elements.</p>
*
* @param <E> the type of elements in the set.
* @param set the set to make unmodifiable, or {@code null}.
@@ -410,7 +410,7 @@ public final class CollectionsExt extends Static {
/**
* Returns a unmodifiable version of the given map.
* This method is different than the standard {@link
Collections#unmodifiableMap(Map)}
- * in that it tries to returns a more efficient object when there is zero
or one entry.
+ * in that it tries to return a more efficient object when there is zero
or one entry.
* Such small maps occur frequently in Apache SIS.
*
* <p><em>The map returned by this method may or may not be a view of the
given map</em>.
@@ -419,7 +419,7 @@ public final class CollectionsExt extends Static {
* standard {@link Collections#unmodifiableMap(Map)} method instead.</p>
*
* <p>This method differs from {@link Map#copyOf(Map)} in that it may
avoid copy,
- * preserves element order and optionally null elements.</p>
+ * preserves element order and accepts null elements.</p>
*
* @param <K> the type of keys in the map.
* @param <V> the type of values in the map.
