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 8983130bd4463b568f553c53fe4f6744532c14d2
Author: Martin Desruisseaux <martin.desruisse...@geomatys.com>
AuthorDate: Tue Feb 1 19:47:25 2022 +0100
Fix a few typos in javadoc.
---
.../org/apache/sis/internal/storage/inflater/CCITTRLE.java | 4 ++--
.../sis/internal/storage/inflater/CompressionChannel.java | 2 +-
.../sis/internal/storage/inflater/HorizontalPredictor.java | 2 +-
.../java/org/apache/sis/internal/storage/inflater/LZW.java | 12 ++++++------
.../org/apache/sis/internal/storage/inflater/PackBits.java | 4 ++--
.../apache/sis/internal/storage/inflater/PixelChannel.java | 2 +-
.../sis/internal/storage/inflater/PredictorChannel.java | 4 ++--
.../java/org/apache/sis/internal/storage/inflater/ZIP.java | 6 +++---
8 files changed, 18 insertions(+), 18 deletions(-)
diff --git
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/CCITTRLE.java
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/CCITTRLE.java
index 0d7bac2..cf44863 100644
---
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/CCITTRLE.java
+++
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/CCITTRLE.java
@@ -131,7 +131,7 @@ final class CCITTRLE extends CompressionChannel {
* Prepares this inflater for reading a new tile or a new band of a tile.
*
* @param start stream position where to start reading.
- * @param byteCount number of byte to read from the input.
+ * @param byteCount number of bytes to read from the input.
* @throws IOException if the stream can not be seek to the given start
position.
*/
@Override
@@ -184,7 +184,7 @@ final class CCITTRLE extends CompressionChannel {
}
/**
- * Decompresses some bytes from the {@linkplain #input} into the given
destination buffer.
+ * Decompresses some bytes from the {@linkplain #input input} into the
given destination buffer.
*
* @param target the buffer into which bytes are to be transferred.
* @return the number of bytes read, or -1 if end-of-stream.
diff --git
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/CompressionChannel.java
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/CompressionChannel.java
index ec97aa3..95e5473 100644
---
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/CompressionChannel.java
+++
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/CompressionChannel.java
@@ -64,7 +64,7 @@ abstract class CompressionChannel extends PixelChannel {
* Prepares this inflater for reading a new tile or a new band of a tile.
*
* @param start stream position where to start reading.
- * @param byteCount number of byte to read from the input.
+ * @param byteCount number of bytes to read from the input.
* @throws IOException if the stream can not be seek to the given start
position.
*/
@Override
diff --git
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/HorizontalPredictor.java
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/HorizontalPredictor.java
index 263a01c..54da470 100644
---
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/HorizontalPredictor.java
+++
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/HorizontalPredictor.java
@@ -122,7 +122,7 @@ abstract class HorizontalPredictor extends PredictorChannel
{
* Prepares this predictor for reading a new tile or a new band of a tile.
*
* @param start stream position where to start reading.
- * @param byteCount number of byte to read from the input.
+ * @param byteCount number of bytes to read from the input.
* @throws IOException if the stream can not be seek to the given start
position.
*/
@Override
diff --git
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/LZW.java
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/LZW.java
index 07d4e84..583732f 100644
---
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/LZW.java
+++
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/LZW.java
@@ -26,7 +26,7 @@ import org.apache.sis.internal.storage.io.ChannelDataInput;
/**
* Inflater for values encoded with the LZW compression.
- * This compression is described in section 13 of TIFF 6 specification. "LZW
Compression".
+ * This compression is described in section 13 of TIFF 6 specification, "LZW
Compression".
* Each code is written using at least 9 bits and at most 12 bits.
*
* <h2>Legal note</h2>
@@ -41,7 +41,7 @@ import org.apache.sis.internal.storage.io.ChannelDataInput;
final class LZW extends CompressionChannel {
/**
* A 12 bits code meaning that we have exhausted the 4093 available codes
- * and most reset the table to the initial set of 9 bits code.
+ * and must reset the table to the initial set of 9 bits code.
*/
private static final int CLEAR_CODE = 256;
@@ -51,7 +51,7 @@ final class LZW extends CompressionChannel {
private static final int EOI_CODE = 257;
/**
- * First code which is not one of the predefined nodes.
+ * First code which is not one of the predefined codes.
*/
private static final int FIRST_ADAPTATIVE_CODE = 258;
@@ -91,7 +91,7 @@ final class LZW extends CompressionChannel {
/**
* Number of bits to read for the next code. This number starts at 9 and
increases until {@value #MAX_CODE_SIZE}.
- * After {@value #MAX_CODE_SIZE} bits, a {@link #CLEAR_CODE} should occurs
in the stream of LZW data.
+ * After {@value #MAX_CODE_SIZE} bits, a {@link #CLEAR_CODE} should occur
in the stream of LZW data.
*/
private int codeSize;
@@ -122,7 +122,7 @@ final class LZW extends CompressionChannel {
* Prepares this inflater for reading a new tile or a new band of a tile.
*
* @param start stream position where to start reading.
- * @param byteCount number of byte to read from the input.
+ * @param byteCount number of bytes to read from the input.
* @throws IOException if the stream can not be seek to the given start
position.
*/
@Override
@@ -136,7 +136,7 @@ final class LZW extends CompressionChannel {
}
/**
- * Decompresses some bytes from the {@linkplain #input} into the given
destination buffer.
+ * Decompresses some bytes from the {@linkplain #input input} into the
given destination buffer.
*
* @param target the buffer into which bytes are to be transferred.
* @return the number of bytes read, or -1 if end-of-stream.
diff --git
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/PackBits.java
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/PackBits.java
index 51b1e59..650633f 100644
---
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/PackBits.java
+++
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/PackBits.java
@@ -63,7 +63,7 @@ final class PackBits extends CompressionChannel {
* Prepares this inflater for reading a new tile or a new band of a tile.
*
* @param start stream position where to start reading.
- * @param byteCount number of byte to read from the input.
+ * @param byteCount number of bytes to read from the input.
* @throws IOException if the stream can not be seek to the given start
position.
*/
@Override
@@ -74,7 +74,7 @@ final class PackBits extends CompressionChannel {
}
/**
- * Decompresses some bytes from the {@linkplain #input} into the given
destination buffer.
+ * Decompresses some bytes from the {@linkplain #input input} into the
given destination buffer.
*
* @param target the buffer into which bytes are to be transferred.
* @return the number of bytes read, or -1 if end-of-stream.
diff --git
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/PixelChannel.java
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/PixelChannel.java
index a4f2ba9..5247497 100644
---
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/PixelChannel.java
+++
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/PixelChannel.java
@@ -48,7 +48,7 @@ abstract class PixelChannel implements ReadableByteChannel {
* Prepares this channel for reading a new tile or a new band of a tile.
*
* @param start stream position where to start reading.
- * @param byteCount number of byte to read from the input.
+ * @param byteCount number of bytes to read from the input.
* @throws IOException if the stream can not be seek to the given start
position.
*/
public abstract void setInputRegion(long start, long byteCount) throws
IOException;
diff --git
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/PredictorChannel.java
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/PredictorChannel.java
index 00f8876..e10fc76 100644
---
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/PredictorChannel.java
+++
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/PredictorChannel.java
@@ -64,7 +64,7 @@ abstract class PredictorChannel extends PixelChannel {
* Prepares this predictor for reading a new tile or a new band of a tile.
*
* @param start stream position where to start reading.
- * @param byteCount number of byte to read from the input.
+ * @param byteCount number of bytes to read from the input.
* @throws IOException if the stream can not be seek to the given start
position.
*/
@Override
@@ -85,7 +85,7 @@ abstract class PredictorChannel extends PixelChannel {
protected abstract int uncompress(ByteBuffer buffer, int start);
/**
- * Decompresses some bytes from the {@linkplain #input} into the given
destination buffer.
+ * Decompresses some bytes from the {@linkplain #input input} into the
given destination buffer.
*
* @param target the buffer into which bytes are to be transferred.
* @return the number of bytes read, or -1 if end-of-stream.
diff --git
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/ZIP.java
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/ZIP.java
index 1810e9b..a4f5c1f 100644
---
a/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/ZIP.java
+++
b/storage/sis-geotiff/src/main/java/org/apache/sis/internal/storage/inflater/ZIP.java
@@ -47,7 +47,7 @@ final class ZIP extends CompressionChannel {
*
* @param input the source of data to decompress.
* @param start stream position where to start reading.
- * @param byteCount number of byte to read from the input.
+ * @param byteCount number of bytes to read from the input.
* @throws IOException if the stream can not be seek to the given start
position.
*/
public ZIP(final ChannelDataInput input) {
@@ -59,7 +59,7 @@ final class ZIP extends CompressionChannel {
* Prepares this inflater for reading a new tile or a new band of a tile.
*
* @param start stream position where to start reading.
- * @param byteCount number of byte to read from the input.
+ * @param byteCount number of bytes to read from the input.
* @throws IOException if the stream can not be seek to the given start
position.
*/
@Override
@@ -69,7 +69,7 @@ final class ZIP extends CompressionChannel {
}
/**
- * Decompresses some bytes from the {@linkplain #input} into the given
destination buffer.
+ * Decompresses some bytes from the {@linkplain #input input} into the
given destination buffer.
*
* @param target the buffer into which bytes are to be transferred.
* @return the number of bytes read, or -1 if end-of-stream.
