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 1e3b96aaa1246daa06c20ff32d194aea8512eaf9
Author: Martin Desruisseaux <martin.desruisse...@geomatys.com>
AuthorDate: Wed Feb 28 15:04:54 2024 +0100
Documentation fixes and formatting.
---
.../org/apache/sis/util/iso/DefaultRecordType.java | 9 +++---
.../apache/sis/referencing/cs/AxesConvention.java | 32 ++++++++++++----------
2 files changed, 22 insertions(+), 19 deletions(-)
diff --git
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/util/iso/DefaultRecordType.java
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/util/iso/DefaultRecordType.java
index fff042ed4f..69646b3a26 100644
---
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/util/iso/DefaultRecordType.java
+++
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/util/iso/DefaultRecordType.java
@@ -113,7 +113,7 @@ public class DefaultRecordType extends RecordDefinition
implements RecordType, S
*
* @param other the {@code RecordType} to copy.
*/
- @SuppressWarnings("deprecation")
+ @SuppressWarnings({"deprecation", "this-escape"})
public DefaultRecordType(final RecordType other) {
typeName = other.getTypeName();
container = other.getContainer();
@@ -201,6 +201,7 @@ public class DefaultRecordType extends RecordDefinition
implements RecordType, S
this.typeName = typeName;
this.container = container;
final NameSpace namespace = nameFactory.createNameSpace(typeName,
null);
+ @SuppressWarnings("LocalVariableHidesMemberVariable")
final Map<MemberName,Type> fieldTypes =
JDK19.newLinkedHashMap(fields.size());
for (final Map.Entry<? extends CharSequence, ? extends Type> entry :
fields.entrySet()) {
final Type type = entry.getValue();
@@ -387,7 +388,7 @@ public class DefaultRecordType extends RecordDefinition
implements RecordType, S
/**
* Determines if the given record is compatible with this record type.
This method returns {@code true}
- * if the given {@code record} argument is non-null and the following
condition holds:
+ * if the given {@code record} argument is non-null and the following
condition is true:
*
* {@snippet lang="java" :
* Set<MemberName> attributeNames = record.getAttributes().keySet();
@@ -398,8 +399,8 @@ public class DefaultRecordType extends RecordDefinition
implements RecordType, S
* We do not require that {@code record.getRecordType() == this} in order
to allow record
* "sub-types" to define additional fields, in a way similar to Java
sub-classing.
*
- * @param record the record to test for compatibility.
- * @return {@code true} if the given record is compatible with this {@code
RecordType}.
+ * @param record the record to test for compatibility with this type, or
{@code null}.
+ * @return {@code true} if the given record is non-null and compatible
with this record type.
*/
@Override
public boolean isInstance(final Record record) {
diff --git
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/cs/AxesConvention.java
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/cs/AxesConvention.java
index 19bee52858..6261a1b041 100644
---
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/cs/AxesConvention.java
+++
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/cs/AxesConvention.java
@@ -37,37 +37,39 @@ import org.apache.sis.measure.Units;
* <table class="sis">
* <caption>Coordinate system properties changed by enum values</caption>
* <tr>
- * <th>Property</th>
- * <th>Example</th>
- * <th>{@linkplain #NORMALIZED Normalized}</th>
- * <th>{@link #DISPLAY_ORIENTED Display<br>oriented}</th>
- * <th>{@linkplain #RIGHT_HANDED Right<br>handed}</th>
- * <th>{@linkplain #POSITIVE_RANGE Positive<br>range}</th>
+ * <th rowspan="2">Property</th>
+ * <th class="sep" rowspan="2">Example</th>
+ * <th class="sep" colspan="4">Modified by:</th>
+ * </tr><tr>
+ * <th class="sep">{@linkplain #NORMALIZED Normalized}</th>
+ * <th>{@linkplain #DISPLAY_ORIENTED Display<br>oriented}</th>
+ * <th>{@linkplain #RIGHT_HANDED Right<br>handed}</th>
+ * <th>{@linkplain #POSITIVE_RANGE Positive<br>range}</th>
* </tr><tr>
* <td>Axis order</td>
- * <td>(<var>longitude</var>, <var>latitude</var>)</td>
- * <td style="text-align:center">✔</td>
+ * <td> class="sep"(<var>longitude</var>, <var>latitude</var>)</td>
+ * <td class="sep" style="text-align:center">✔</td>
* <td style="text-align:center">✔</td>
* <td style="text-align:center">✔</td>
* <td></td>
* </tr><tr>
* <td>Axis direction</td>
- * <td>({@linkplain AxisDirection#EAST east}, {@linkplain
AxisDirection#NORTH north})</td>
- * <td style="text-align:center">✔</td>
+ * <td> class="sep"({@linkplain AxisDirection#EAST east}, {@linkplain
AxisDirection#NORTH north})</td>
+ * <td class="sep" style="text-align:center">✔</td>
* <td style="text-align:center">✔</td>
* <td></td>
* <td></td>
* </tr><tr>
* <td>Unit of measurement</td>
- * <td>Angular degrees & metres</td>
- * <td style="text-align:center">✔</td>
+ * <td> class="sep"Angular degrees & metres</td>
+ * <td class="sep" style="text-align:center">✔</td>
* <td></td>
* <td></td>
* <td></td>
* </tr><tr>
* <td>Range of values</td>
- * <td>[0 … 360]° of longitude</td>
- * <td></td>
+ * <td> class="sep"[0 … 360]° of longitude</td>
+ * <td> class="sep"</td>
* <td></td>
* <td></td>
* <td style="text-align:center">✔</td>
@@ -78,7 +80,7 @@ import org.apache.sis.measure.Units;
* The axis order is specified by the authority (typically a national agency)
defining the Coordinate Reference System
* (CRS). The order depends on the CRS type and the country defining the CRS.
In the case of geographic CRS, the
* (<var>latitude</var>, <var>longitude</var>) axis order is widely used by
geographers and pilots for centuries.
- * However, software developers tend to consistently use the
(<var>x</var>,<var>y</var>) order for every kind of CRS.
+ * However, software developers tend to consistently use the
(<var>x</var>,<var>y</var>) order for every kinds of CRS.
* Those different practices resulted in contradictory definitions of axis
order for almost every CRS of kind
* {@code GeographicCRS}, for some {@code ProjectedCRS} in the South
hemisphere (South Africa, Australia, <i>etc.</i>)
* and for some polar projections among others.
