This is an automated email from the ASF dual-hosted git repository. asf-gitbox-commits pushed a commit to branch geoapi-4.0 in repository https://gitbox.apache.org/repos/asf/sis.git
commit e50cbb947e60d12b149410c71ffd8b3e3bba5e3d Author: Martin Desruisseaux <[email protected]> AuthorDate: Thu Nov 5 10:53:13 2026 +0100 Reduce a little bit the number of <h4> in javadoc, because they are added by the javadoc tool in the search bar. --- .../sis/coverage/grid/DimensionalityReduction.java | 6 +++--- .../org/apache/sis/coverage/grid/GridDerivation.java | 4 ++-- .../main/org/apache/sis/image/ImageProcessor.java | 8 ++++---- .../main/org/apache/sis/image/MaskedImage.java | 4 ++-- .../test/org/apache/sis/image/PixelIteratorTest.java | 8 ++++---- .../main/org/apache/sis/geometry/AbstractEnvelope.java | 12 ++++++------ .../main/org/apache/sis/geometry/GeneralEnvelope.java | 18 +++++++++--------- .../org/apache/sis/geometry/WraparoundAdjustment.java | 2 +- .../main/org/apache/sis/gui/map/MapCanvasAWT.java | 4 ++-- 9 files changed, 33 insertions(+), 33 deletions(-) diff --git a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/grid/DimensionalityReduction.java b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/grid/DimensionalityReduction.java index 9c8f36fbc4..981a388d74 100644 --- a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/grid/DimensionalityReduction.java +++ b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/grid/DimensionalityReduction.java @@ -625,10 +625,10 @@ public class DimensionalityReduction implements UnaryOperator<GridCoverage>, Ser /** * Returns a coordinate tuple on which dimensionality reduction has been applied. * - * <h4>Precondition</h4> + * <p><b>Precondition:</b> * The coordinate reference system of the given {@code source} should be either - * null or equal (ignoring metadata) to the CRS of the source grid geometry. - * For performance reason, this condition is not verified unless Java assertions are enabled. + * null or equal (ignoring metadata) to the <abbr>CRS</abbr> of the source grid geometry. + * For performance reason, this condition is not verified unless Java assertions are enabled.</p> * * @param source the source coordinate tuple, or {@code null}. * @return the reduced coordinate tuple, or {@code null} if the given source was null. diff --git a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/grid/GridDerivation.java b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/grid/GridDerivation.java index dd6565d815..afd15e6352 100644 --- a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/grid/GridDerivation.java +++ b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/grid/GridDerivation.java @@ -1076,10 +1076,10 @@ public class GridDerivation { * * The {@linkplain GridGeometry#getGridToCRS(PixelInCell) grid to CRS} transform is scaled accordingly * - * <h4>Preconditions</h4> + * <p><b>Precondition:</b> * This method assumes that subsampling are divisors of {@linkplain #chunkSize(int...) chunk sizes} * and are not greater than the {@linkplain #maximumSubsampling(long...) maximum subsampling}. - * It is caller responsibility to ensure that those preconditions are met. + * It is caller responsibility to ensure that this precondition is met.</p> * * @param subsampling the subsampling to apply on each grid dimension. All values shall be greater than zero. * If the array length is shorter than the number of dimensions, missing values are assumed to be 1. diff --git a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/image/ImageProcessor.java b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/image/ImageProcessor.java index f53fc03af9..9dd051cf82 100644 --- a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/image/ImageProcessor.java +++ b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/image/ImageProcessor.java @@ -947,10 +947,10 @@ public class ImageProcessor implements Cloneable { * The returned image may share some tiles from any source images (without copy) * if the tile can be used directly with no change. * - * <h4>Preconditions</h4> + * <p><b>Preconditions:</b> * All source images shall have the same number of bands (but not necessarily the same sample model). * All source images should have equivalent color model, otherwise color consistency is not guaranteed. - * At least one image shall intersect the given bounds. + * At least one image shall intersect the given bounds.</p> * * <h4>Properties used</h4> * This operation uses the following properties in addition to method parameters: @@ -994,8 +994,8 @@ public class ImageProcessor implements Cloneable { * approach of creating views as much as possible. Therefore, this method should be used only * when necessary. * - * <h4>Preconditions</h4> - * The new sample model shall have the same number of bands as in the given image. + * <p><b>Precondition:</b> + * The new sample model shall have the same number of bands as in the given image.</p> * * <h4>Properties used</h4> * This operation uses the following properties in addition to method parameters: diff --git a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/image/MaskedImage.java b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/image/MaskedImage.java index a3f325f1b1..9e01d268c6 100644 --- a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/image/MaskedImage.java +++ b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/image/MaskedImage.java @@ -174,8 +174,8 @@ final class MaskedImage extends SourceAlignedImage { * int pixel = (element >>> shift) & 1; * } * - * <h4>Preconditions</h4> - * The {@link #getMaskTiles()} method must have been invoked at least once before this method. + * <p><b>Precondition:</b> + * The {@link #getMaskTiles()} method must have been invoked at least once before this method.</p> */ private synchronized ByteBuffer getMask() { ByteBuffer mask; diff --git a/endorsed/src/org.apache.sis.feature/test/org/apache/sis/image/PixelIteratorTest.java b/endorsed/src/org.apache.sis.feature/test/org/apache/sis/image/PixelIteratorTest.java index eaaf4c76eb..c5297616af 100644 --- a/endorsed/src/org.apache.sis.feature/test/org/apache/sis/image/PixelIteratorTest.java +++ b/endorsed/src/org.apache.sis.feature/test/org/apache/sis/image/PixelIteratorTest.java @@ -145,9 +145,9 @@ public class PixelIteratorTest extends TestCase { * Creates a {@code WritableRaster} to use as the source of test data. * The raster is filled with arbitrary sample values. * - * <h4>Preconditions</h4> + * <p><b>Precondition:</b> * Before invocation, the {@link #xmin}, {@link #ymin}, {@link #width}, {@link #height} and {@link #numBands} - * fields must be initialized. + * fields must be initialized.</p> * * @param subArea the raster subarea on which to perform iteration, or {@code null} for the whole area. * @return a raster filled with arbitrary sample values. @@ -204,9 +204,9 @@ public class PixelIteratorTest extends TestCase { * Creates a {@code RenderedImage} to use as the source of test data. * The image is filled with arbitrary sample values. * - * <h4>Preconditions</h4> + * <p><b>Precondition:</b> * Before invocation, the {@link #xmin}, {@link #ymin}, {@link #width}, {@link #height}, - * {@link #tileWidth}, {@link #tileHeight} and {@link #numBands} fields must be initialized. + * {@link #tileWidth}, {@link #tileHeight} and {@link #numBands} fields must be initialized.</p> * * @param subArea the image subarea on which to perform iteration, or {@code null} for the whole area. * @return an image filled with arbitrary sample values. diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/geometry/AbstractEnvelope.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/geometry/AbstractEnvelope.java index 1c82d1b6b9..c5fdab0e32 100644 --- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/geometry/AbstractEnvelope.java +++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/geometry/AbstractEnvelope.java @@ -765,9 +765,9 @@ public abstract class AbstractEnvelope extends FormattableObject implements Enve * If it least one coordinate value in the given point is {@link Double#NaN NaN}, * then this method returns {@code false}. * - * <h4>Preconditions</h4> + * <p><b>Precondition:</b> * This method assumes that the specified point uses a CRS equivalent to this envelope CRS. - * For performance reasons, this condition is not verified unless Java assertions are enabled. + * For performance reasons, this condition is not verified unless Java assertions are enabled.</p> * * <h4>Crossing the anti-meridian of a Geographic CRS</h4> * For any dimension, if <var>upper</var> < <var>lower</var> then this method uses an @@ -817,9 +817,9 @@ public abstract class AbstractEnvelope extends FormattableObject implements Enve * * <blockquote><pre>{@linkplain #contains(Envelope, boolean) contains}(envelope, <b>true</b>)</pre></blockquote> * - * <h4>Preconditions</h4> + * <p><b>Precondition:</b> * This method assumes that the specified envelope uses the same CRS as this envelope. - * For performance reasons, this condition is not verified unless Java assertions are enabled. + * For performance reasons, this condition is not verified unless Java assertions are enabled.</p> * * <h4>Crossing the anti-meridian of a Geographic CRS</h4> * For every cases illustrated below, the yellow box is considered completely enclosed @@ -947,9 +947,9 @@ public abstract class AbstractEnvelope extends FormattableObject implements Enve * * <blockquote><pre>{@linkplain #intersects(Envelope, boolean) intersects}(envelope, <b>false</b>)</pre></blockquote> * - * <h4>Preconditions</h4> + * <p><b>Precondition:</b> * This method assumes that the specified envelope uses the same CRS as this envelope. - * For performance reasons, this condition is not verified unless Java assertions are enabled. + * For performance reasons, this condition is not verified unless Java assertions are enabled.</p> * * <h4>Crossing the anti-meridian of a Geographic CRS</h4> * This method can handle envelopes crossing the anti-meridian. diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/geometry/GeneralEnvelope.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/geometry/GeneralEnvelope.java index 297b23b1d9..a23d0b4dda 100644 --- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/geometry/GeneralEnvelope.java +++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/geometry/GeneralEnvelope.java @@ -533,11 +533,11 @@ public class GeneralEnvelope extends ArrayEnvelope implements Cloneable, Seriali * with the added point as an argument will return {@code true}, except if one of the point * coordinates was {@link Double#NaN} in which case the corresponding coordinate has been ignored.</p> * - * <h4>Preconditions</h4> + * <p><b>Precondition:</b> * This method assumes that the specified point uses a CRS equivalent to this envelope CRS. - * For performance reasons, this condition is not verified unless Java assertions are enabled. + * For performance reasons, this condition is not verified unless Java assertions are enabled.</p> * - * <h4>Crossing the anti-meridian of a Geographic CRS</h4> + * <h4>Addition of point in an envelope crossing the anti-meridian of a Geographic CRS</h4> * This method supports envelopes crossing the anti-meridian. In such cases it is possible to * move both envelope borders in order to encompass the given point, as illustrated below (the * new point is represented by the {@code +} symbol): @@ -611,11 +611,11 @@ public class GeneralEnvelope extends ArrayEnvelope implements Cloneable, Seriali * Adds an envelope object to this envelope. * The resulting envelope is the union of the two {@code Envelope} objects. * - * <h4>Preconditions</h4> + * <p><b>Precondition:</b> * This method assumes that the specified envelope uses a CRS equivalent to this envelope CRS. - * For performance reasons, this condition is not verified unless Java assertions are enabled. + * For performance reasons, this condition is not verified unless Java assertions are enabled.</p> * - * <h4>Crossing the anti-meridian of a Geographic CRS</h4> + * <h4>Union of envelopes crossing the anti-meridian of a Geographic CRS</h4> * This method supports envelopes crossing the anti-meridian. If one or both envelopes cross * the anti-meridian, then the result of the {@code add} operation may be an envelope expanding * to infinities. In such case, the coordinate range will be either [−∞…∞] or [0…−0] depending on @@ -768,11 +768,11 @@ public class GeneralEnvelope extends ArrayEnvelope implements Cloneable, Seriali /** * Sets this envelope to the intersection of this envelope with the specified one. * - * <h4>Preconditions</h4> + * <p><b>Precondition:</b> * This method assumes that the specified envelope uses a CRS equivalent to this envelope CRS. - * For performance reasons, this condition is not verified unless Java assertions are enabled. + * For performance reasons, this condition is not verified unless Java assertions are enabled.</p> * - * <h4>Crossing the anti-meridian of a Geographic CRS</h4> + * <h4>Intersection of envelopes crossing the anti-meridian of a Geographic CRS</h4> * This method supports envelopes crossing the anti-meridian. * * <h4>Handling of NaN values</h4> diff --git a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/geometry/WraparoundAdjustment.java b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/geometry/WraparoundAdjustment.java index 2ba9294643..172f8f8471 100644 --- a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/geometry/WraparoundAdjustment.java +++ b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/geometry/WraparoundAdjustment.java @@ -273,7 +273,7 @@ public class WraparoundAdjustment { * <p>If a {@link #domainToInput} has been explicitly specified to the constructor, * that transform is unconditionally used and the {@code crs} argument is ignored.</p> * - * <h4>Preconditions</h4> + * <p><b>Preconditions:</b></p> * <ul> * <li>The {@link #inputToShiftable} transform must be initialized.</li> * <li>The {@link #shiftableDomain} field is assumed initialized to {@link #domainOfValidity}.</li> diff --git a/optional/src/org.apache.sis.gui/main/org/apache/sis/gui/map/MapCanvasAWT.java b/optional/src/org.apache.sis.gui/main/org/apache/sis/gui/map/MapCanvasAWT.java index 16a2611d58..a648b884fc 100644 --- a/optional/src/org.apache.sis.gui/main/org/apache/sis/gui/map/MapCanvasAWT.java +++ b/optional/src/org.apache.sis.gui/main/org/apache/sis/gui/map/MapCanvasAWT.java @@ -346,10 +346,10 @@ public abstract class MapCanvasAWT extends MapCanvas { * In all cases we need to be careful to not use directly any {@link MapCanvas} field from the {@code call()} * methods. Information needed by {@code call()} must be copied first. * - * <h4>Preconditions</h4> + * <p><b>Precondition:</b> * It is important that no other worker is in progress at the time this method is invoked * ({@code assert renderingInProgress == null}), otherwise conflicts may happen when workers - * will update the {@code MapCanvasAWT} fields after they completed their task. + * will update the {@code MapCanvasAWT} fields after they completed their task.</p> * * @see #requestRepaint() */
