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
The following commit(s) were added to refs/heads/geoapi-4.0 by this push:
new c847947bde Fix some Javadoc warnings.
c847947bde is described below
commit c847947bde095bc7b55544bb6d5d611b7cba4890
Author: Martin Desruisseaux <martin.desruisse...@geomatys.com>
AuthorDate: Tue Oct 3 23:45:15 2023 +0200
Fix some Javadoc warnings.
---
.../main/org/apache/sis/filter/sqlmm/OneGeometry.java | 2 ++
.../main/org/apache/sis/filter/sqlmm/ST_Transform.java | 2 ++
.../main/org/apache/sis/filter/sqlmm/TwoGeometries.java | 2 ++
.../org.apache.sis.metadata/main/org/apache/sis/util/iso/Types.java | 5 ++---
.../org/apache/sis/xml/bind/metadata/replace/QualityParameter.java | 6 +++---
.../main/org/apache/sis/referencing/AbstractIdentifiedObject.java | 4 ++--
.../org/apache/sis/referencing/factory/GeodeticObjectFactory.java | 4 ++--
.../main/org/apache/sis/storage/gpx/WritableStore.java | 1 -
.../main/org/apache/sis/storage/StorageConnector.java | 2 ++
.../main/org/apache/sis/storage/WritableFeatureSet.java | 1 -
.../main/org/apache/sis/converter/NumberConverter.java | 2 ++
.../main/org/apache/sis/converter/ObjectToString.java | 4 ++++
.../main/org/apache/sis/converter/StringConverter.java | 4 ++++
.../main/org/apache/sis/util/collection/WeakValueHashMap.java | 2 +-
.../main/org/apache/sis/util/internal/MetadataServices.java | 2 --
.../main/org/apache/sis/gui/map/ValuesFormatter.java | 2 +-
16 files changed, 29 insertions(+), 16 deletions(-)
diff --git
a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/OneGeometry.java
b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/OneGeometry.java
index a64c216bd0..5d26727042 100644
---
a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/OneGeometry.java
+++
b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/OneGeometry.java
@@ -103,6 +103,8 @@ class OneGeometry<R> extends SpatialFunction<R> {
/**
* SQLMM spatial functions taking a single geometry operand with one
argument.
+ *
+ * @param <R> the type of resources (e.g. {@code Feature}) used as
inputs.
*/
static final class WithArgument<R> extends OneGeometry<R> {
/** For cross-version compatibility. */
diff --git
a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/ST_Transform.java
b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/ST_Transform.java
index b53f00f620..15ea2201be 100644
---
a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/ST_Transform.java
+++
b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/ST_Transform.java
@@ -58,6 +58,8 @@ import org.opengis.filter.InvalidFilterValueException;
*
* @author Johann Sorel (Geomatys)
* @author Martin Desruisseaux (Geomatys)
+ *
+ * @param <R> the type of resources (e.g. {@code Feature}) used as inputs.
*/
final class ST_Transform<R> extends FunctionWithSRID<R> {
/**
diff --git
a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/TwoGeometries.java
b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/TwoGeometries.java
index e205ee0e52..1d856296b5 100644
---
a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/TwoGeometries.java
+++
b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/sqlmm/TwoGeometries.java
@@ -148,6 +148,8 @@ class TwoGeometries<R> extends SpatialFunction<R> {
/**
* SQLMM spatial functions taking a single geometry operand with one
argument.
+ *
+ * @param <R> the type of resources (e.g. {@code Feature}) used as
inputs.
*/
static final class WithArgument<R> extends TwoGeometries<R> {
/** For cross-version compatibility. */
diff --git
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/util/iso/Types.java
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/util/iso/Types.java
index 236c62eed4..0d19f3ef5d 100644
---
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/util/iso/Types.java
+++
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/util/iso/Types.java
@@ -403,9 +403,8 @@ public final class Types extends Static {
/**
* The {@link InternationalString} returned by the {@code
Types.getCodeTitle(…)} method.
- * The code below is a duplicated - in a different way - of {@code
CodeListUID(CodeList)}
- * constructor ({@link org.apache.sis.xml.bind.metadata.code package}).
This duplication exists
- * because {@code CodeListUID} constructor stores more information in an
opportunist way.
+ * The code below is a duplicated - in a different way - of {@code
CodeListUID(CodeList)} constructor.
+ * This duplication exists because {@code CodeListUID} constructor stores
more information in an opportunist way.
* If this class is updated, please update {@code CodeListUID(CodeList)}
accordingly.
*
* @author Martin Desruisseaux (Geomatys)
diff --git
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/metadata/replace/QualityParameter.java
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/metadata/replace/QualityParameter.java
index b89778816b..cd288e6726 100644
---
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/metadata/replace/QualityParameter.java
+++
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/metadata/replace/QualityParameter.java
@@ -94,8 +94,6 @@ public final class QualityParameter extends Parameter {
/**
* Description of the data quality parameter.
- *
- * @see #getDescription()
*/
@XmlElement
@SuppressWarnings("serial") // Most Apache SIS
implementations are serializable.
@@ -224,13 +222,15 @@ public final class QualityParameter extends Parameter {
* <li>If the given class is a class, then its {@linkplain
Class#getComponentType() component type} is used.</li>
* <li>Otherwise if the class is an {@link Iterable}, then the upper
bound of elements is fetched.</li>
* <li>Otherwise if the class is a {@link Map}, then the upper bound of
keys is fetched.</li>
- * <li>Otherwise if the class is a {@link Matrix} or {@link Coverage},
then {@link Double} components is assumed.</li>
+ * <li>Otherwise if the class is a {@link Matrix}, then {@link Double}
components is assumed.</li>
* <li>Otherwise the given class is used as if it was already a
component type (i.e. a singleton item).</li>
* </ul>
*
* This method is used for mapping {@link Class} to ({@link
ValueStructure}, {@link TypeName}) pair.
* The other member of the pair is given by {@link
ValueStructure#valueOf(Class)}.
*
+ * @todo {@code Coverage} case needs to be added. It would be handle like
{@link Matrix}.
+ *
* @param valueClass the type of values for which to infer a {@link
TypeName} instance.
* @return a type name for components of the given type.
*/
diff --git
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/AbstractIdentifiedObject.java
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/AbstractIdentifiedObject.java
index 6f151ff192..037028c526 100644
---
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/AbstractIdentifiedObject.java
+++
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/AbstractIdentifiedObject.java
@@ -220,8 +220,8 @@ public class AbstractIdentifiedObject extends
FormattableObject implements Ident
* because we may get both on unmarshalling.
*
* <p><b>Consider this field as final!</b>
- * This field is modified only at unmarshalling time by {@link
#setScope(InternationalString)}
- * and {@link #setDomainOfValidity(Extent)}.</p>
+ * This field is modified only at unmarshalling time by {@link
#setDomainScope(InternationalString)}
+ * and {@link #setDomainExtent(Extent)}.</p>
*
* @see #getDomains()
*/
diff --git
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticObjectFactory.java
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticObjectFactory.java
index 6608e775b6..95c4401371 100644
---
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticObjectFactory.java
+++
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticObjectFactory.java
@@ -131,11 +131,11 @@ import org.apache.sis.xml.XML;
* </tr><tr>
* <td>{@value org.opengis.referencing.IdentifiedObject#DOMAINS_KEY}</td>
* <td>{@link org.opengis.referencing.ObjectDomain} (optionally as
array)</td>
- * <td>{@link #getDomains()}</td>
+ * <td>{@link AbstractIdentifiedObject#getDomains()}</td>
* </tr><tr>
* <td>{@value
org.opengis.referencing.ReferenceSystem#DOMAIN_OF_VALIDITY_KEY}</td>
* <td>{@link Extent}</td>
- * <td>{@link DefaultObjectDomain#getDomainOfValidity()}</td>
+ * <td>{@link
org.apache.sis.referencing.DefaultObjectDomain#getDomainOfValidity()}</td>
* </tr><tr>
* <td>{@value org.opengis.referencing.ReferenceSystem#SCOPE_KEY}</td>
* <td>{@link String} or {@link InternationalString}</td>
diff --git
a/endorsed/src/org.apache.sis.storage.xml/main/org/apache/sis/storage/gpx/WritableStore.java
b/endorsed/src/org.apache.sis.storage.xml/main/org/apache/sis/storage/gpx/WritableStore.java
index b54bee4743..a0c358419f 100644
---
a/endorsed/src/org.apache.sis.storage.xml/main/org/apache/sis/storage/gpx/WritableStore.java
+++
b/endorsed/src/org.apache.sis.storage.xml/main/org/apache/sis/storage/gpx/WritableStore.java
@@ -89,7 +89,6 @@ public final class WritableStore extends Store implements
WritableFeatureSet {
* Removes all feature instances from this {@code FeatureSet} which
matches the given predicate.
*
* @param filter a predicate which returns {@code true} for feature
instances to be removed.
- * @return {@code true} if any elements were removed.
* @throws DataStoreException if the feature stream cannot be obtained or
updated.
*/
@Override
diff --git
a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/StorageConnector.java
b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/StorageConnector.java
index a64c444152..86ee0df6bf 100644
---
a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/StorageConnector.java
+++
b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/StorageConnector.java
@@ -1003,6 +1003,8 @@ public class StorageConnector implements Serializable {
* absent file will rather throw {@link java.nio.file.NoSuchFileException}
or {@link java.io.FileNotFoundException}.
* So this method is useful only for {@link DataStore} having write
capabilities.</p>
*
+ * @return whether returning the storage would have required the creation
of a new file.
+ *
* @since 1.4
*/
public boolean wasProbingAbsentFile() {
diff --git
a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/WritableFeatureSet.java
b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/WritableFeatureSet.java
index 14820d87da..06ce25d8d4 100644
---
a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/WritableFeatureSet.java
+++
b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/WritableFeatureSet.java
@@ -81,7 +81,6 @@ public interface WritableFeatureSet extends FeatureSet {
* Removes all feature instances from this {@code FeatureSet} which
matches the given predicate.
*
* @param filter a predicate which returns {@code true} for feature
instances to be removed.
- * @return {@code true} if any elements were removed.
* @throws DataStoreException if an error occurred while removing features.
*/
void removeIf(Predicate<? super Feature> filter) throws DataStoreException;
diff --git
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/converter/NumberConverter.java
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/converter/NumberConverter.java
index c6f3f81e32..7fb968d353 100644
---
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/converter/NumberConverter.java
+++
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/converter/NumberConverter.java
@@ -142,6 +142,8 @@ final class NumberConverter<S extends Number, T extends
Number> extends SystemCo
/**
* Converter from numbers to comparables. This special case exists because
{@link Number}
* does not implement {@link java.lang.Comparable} directly, but all known
subclasses do.
+ *
+ * @param <S> type of numbers to compare.
*/
static final class Comparable<S extends Number> extends SystemConverter<S,
java.lang.Comparable<?>> {
/**
diff --git
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/converter/ObjectToString.java
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/converter/ObjectToString.java
index f2176973f9..08452c8ecb 100644
---
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/converter/ObjectToString.java
+++
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/converter/ObjectToString.java
@@ -110,6 +110,8 @@ class ObjectToString<S> extends SystemConverter<S,String> {
* Specialized instance for {@link org.opengis.util.CodeList}.
* This class invokes {@link org.opengis.util.CodeList#name()} instead of
{@code toString()}.
*
+ * @param <S> type of code list values.
+ *
* @see org.apache.sis.converter.StringConverter.CodeList
*/
static final class CodeList<S extends org.opengis.util.CodeList<S>>
extends ObjectToString<S> {
@@ -137,6 +139,8 @@ class ObjectToString<S> extends SystemConverter<S,String> {
* Specialized instance for {@link java.lang.Enum}.
* This class invokes {@link java.lang.Enum#name()} instead of {@code
toString()}.
*
+ * @param <S> type of enumeration values.
+ *
* @see org.apache.sis.converter.StringConverter.Enum
*/
static final class Enum<S extends java.lang.Enum<S>> extends
ObjectToString<S> {
diff --git
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/converter/StringConverter.java
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/converter/StringConverter.java
index 9c65a40b2c..17eae4de09 100644
---
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/converter/StringConverter.java
+++
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/converter/StringConverter.java
@@ -341,6 +341,8 @@ abstract class StringConverter<T> extends
SystemConverter<String, T> {
*
* <p>Instances of this class are created by
* {@link SystemRegistry#createConverter(Class, Class)}.</p>
+ *
+ * @param <T> type of code list values.
*/
static final class CodeList<T extends org.opengis.util.CodeList<T>>
extends StringConverter<T> {
/** For cross-version compatibility on serialization. */
@@ -373,6 +375,8 @@ abstract class StringConverter<T> extends
SystemConverter<String, T> {
*
* <p>Instances of this class are created by
* {@link SystemRegistry#createConverter(Class, Class)}.</p>
+ *
+ * @param <T> type of enumeration values.
*/
static final class Enum<T extends java.lang.Enum<T>> extends
StringConverter<T> {
/** For cross-version compatibility on serialization. */
diff --git
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/collection/WeakValueHashMap.java
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/collection/WeakValueHashMap.java
index 8659cf31eb..47d8ed02b4 100644
---
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/collection/WeakValueHashMap.java
+++
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/collection/WeakValueHashMap.java
@@ -283,7 +283,7 @@ public class WeakValueHashMap<K,V> extends AbstractMap<K,V>
{
* <td>{@link Objects#deepEquals(Object, Object)}</td>
* </tr><tr>
* <td>Identity (like {@link java.util.IdentityHashMap})</td>
- * <td>{@link System#identityHashCode()}</td>
+ * <td>{@link System#identityHashCode(Object)}</td>
* <td>{@code (o1,o2) -> o1 == o2}</td>
* </tr>
* </table>
diff --git
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/MetadataServices.java
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/MetadataServices.java
index 0a409488de..851d1d45d5 100644
---
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/MetadataServices.java
+++
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/MetadataServices.java
@@ -165,8 +165,6 @@ public class MetadataServices extends OptionalDependency {
* @param key a key identifying the information to return.
* @param locale language to use if possible.
* @return the information, or {@code null} if none.
- *
- * @see
org.apache.sis.metadata.internal.ReferencingServices#getInformation(String,
Locale)
*/
public String getInformation(String key, Locale locale) {
return null;
diff --git
a/optional/src/org.apache.sis.gui/main/org/apache/sis/gui/map/ValuesFormatter.java
b/optional/src/org.apache.sis.gui/main/org/apache/sis/gui/map/ValuesFormatter.java
index f1f4e36533..7459d0d3bc 100644
---
a/optional/src/org.apache.sis.gui/main/org/apache/sis/gui/map/ValuesFormatter.java
+++
b/optional/src/org.apache.sis.gui/main/org/apache/sis/gui/map/ValuesFormatter.java
@@ -94,7 +94,7 @@ final class ValuesFormatter extends
ValuesUnderCursor.Formatter {
/**
* Buffer where to format the textual content.
* We use this buffer as a synchronization lock because this class is
already synchronized,
- * so synchronizing on {@cod buffer} allows us to use only one lock.
+ * so synchronizing on {@code buffer} allows us to use only one lock.
*/
private final StringBuffer buffer;
