This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-imaging.git
The following commit(s) were added to refs/heads/master by this push:
new 757d284b Javadoc
757d284b is described below
commit 757d284baf862c84fd769fc489305ba4ede9db4b
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:08:45 2026 -0400
Javadoc
---
.../commons/imaging/AbstractImageParser.java | 2 +-
.../apache/commons/imaging/FormatCompliance.java | 2 +-
.../java/org/apache/commons/imaging/ImageInfo.java | 2 +-
.../imaging/common/AbstractBinaryOutputStream.java | 6 +++---
.../apache/commons/imaging/common/Allocator.java | 22 +++++++++++-----------
.../commons/imaging/common/BinaryFunctions.java | 8 ++++----
.../imaging/common/BufferedImageFactory.java | 4 ++--
.../commons/imaging/common/ByteConversions.java | 8 ++++----
.../commons/imaging/common/ImageBuilder.java | 10 +++++-----
.../commons/imaging/common/RationalNumber.java | 2 +-
.../imaging/formats/jpeg/iptc/IptcBlock.java | 4 ++--
.../imaging/formats/jpeg/iptc/IptcParser.java | 4 ++--
.../imaging/formats/jpeg/iptc/IptcTypes.java | 2 +-
.../imaging/formats/jpeg/segments/ComSegment.java | 2 +-
.../imaging/formats/png/chunks/PngChunk.java | 2 +-
.../AbstractTransparencyFilter.java | 2 +-
.../formats/tiff/AbstractTiffImageData.java | 4 ++--
.../formats/tiff/AbstractTiffRasterData.java | 8 ++++----
.../imaging/formats/tiff/TiffDirectory.java | 2 +-
.../commons/imaging/formats/tiff/TiffField.java | 4 ++--
.../imaging/formats/tiff/TiffImageParser.java | 2 +-
.../formats/tiff/TiffImagingParameters.java | 4 ++--
.../imaging/formats/tiff/TiffRasterDataFloat.java | 8 ++++----
.../imaging/formats/tiff/TiffRasterDataInt.java | 8 ++++----
.../formats/tiff/constants/GpsTagConstants.java | 2 +-
.../tiff/constants/TiffPlanarConfiguration.java | 2 +-
.../tiff/datareaders/AbstractImageDataReader.java | 8 ++++----
.../formats/tiff/fieldtypes/AbstractFieldType.java | 2 +-
.../formats/tiff/fieldtypes/FieldTypeLong8.java | 2 +-
.../floatingpoint/PaletteEntry.java | 4 ++--
.../floatingpoint/PhotometricInterpreterFloat.java | 6 +++---
.../tiff/write/AbstractTiffImageWriter.java | 2 +-
.../formats/tiff/write/TiffOutputDirectory.java | 2 +-
.../formats/tiff/write/TiffOutputField.java | 2 +-
.../imaging/formats/tiff/write/TiffOutputSet.java | 2 +-
.../formats/webp/chunks/AbstractWebPChunk.java | 2 +-
.../apache/commons/imaging/icc/IccProfileInfo.java | 6 +++---
.../apache/commons/imaging/palette/ColorGroup.java | 2 +-
.../imaging/palette/MedianCutQuantizer.java | 2 +-
.../imaging/examples/tiff/ReadTagsAndImages.java | 6 +++---
.../imaging/examples/tiff/SurveyTiffFile.java | 4 ++--
.../imaging/formats/png/PngWritePredictorTest.java | 2 +-
.../tiff/TiffFloatingPointMultivariableTest.java | 2 +-
.../formats/tiff/TiffFloatingPointReadTest.java | 2 +-
.../tiff/TiffFloatingPointRoundTripTest.java | 6 +++---
.../imaging/formats/tiff/TiffReadAlphaTest.java | 2 +-
.../formats/tiff/TiffRoundTripInt32Test.java | 2 +-
.../formats/tiff/TiffShortIntRoundTripTest.java | 2 +-
48 files changed, 98 insertions(+), 98 deletions(-)
diff --git a/src/main/java/org/apache/commons/imaging/AbstractImageParser.java
b/src/main/java/org/apache/commons/imaging/AbstractImageParser.java
index f53365f9..25f74d8f 100644
--- a/src/main/java/org/apache/commons/imaging/AbstractImageParser.java
+++ b/src/main/java/org/apache/commons/imaging/AbstractImageParser.java
@@ -725,7 +725,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
/**
* Gets a descriptive name for the implementation of an ImageParser.
*
- * @return a valid, subject-matter-specific string.
+ * @return A valid, subject-matter-specific string.
*/
public abstract String getName();
diff --git a/src/main/java/org/apache/commons/imaging/FormatCompliance.java
b/src/main/java/org/apache/commons/imaging/FormatCompliance.java
index 343d8fbf..a15d32af 100644
--- a/src/main/java/org/apache/commons/imaging/FormatCompliance.java
+++ b/src/main/java/org/apache/commons/imaging/FormatCompliance.java
@@ -34,7 +34,7 @@ public class FormatCompliance {
/**
* Gets the default format compliance instance.
*
- * @return a default FormatCompliance instance that ignores errors.
+ * @return A default FormatCompliance instance that ignores errors.
*/
public static FormatCompliance getDefault() {
return new FormatCompliance("ignore", false);
diff --git a/src/main/java/org/apache/commons/imaging/ImageInfo.java
b/src/main/java/org/apache/commons/imaging/ImageInfo.java
index fc05077a..8c55d695 100644
--- a/src/main/java/org/apache/commons/imaging/ImageInfo.java
+++ b/src/main/java/org/apache/commons/imaging/ImageInfo.java
@@ -259,7 +259,7 @@ public class ImageInfo {
* Returns ImageFormat.IMAGE_FORMAT_UNKNOWN if format is unknown.
* </p>
*
- * @return a constant defined in ImageFormat.
+ * @return A constant defined in ImageFormat.
* @see ImageFormats
*/
public ImageFormat getFormat() {
diff --git
a/src/main/java/org/apache/commons/imaging/common/AbstractBinaryOutputStream.java
b/src/main/java/org/apache/commons/imaging/common/AbstractBinaryOutputStream.java
index 0580adeb..ee749267 100644
---
a/src/main/java/org/apache/commons/imaging/common/AbstractBinaryOutputStream.java
+++
b/src/main/java/org/apache/commons/imaging/common/AbstractBinaryOutputStream.java
@@ -31,7 +31,7 @@ public abstract class AbstractBinaryOutputStream extends
FilterOutputStream {
* Creates a big-endian binary output stream.
*
* @param outputStream the underlying output stream.
- * @return a big-endian binary output stream.
+ * @return A big-endian binary output stream.
*/
public static BigEndianBinaryOutputStream bigEndian(final OutputStream
outputStream) {
return new BigEndianBinaryOutputStream(outputStream);
@@ -42,7 +42,7 @@ public abstract class AbstractBinaryOutputStream extends
FilterOutputStream {
*
* @param outputStream the underlying output stream.
* @param byteOrder the byte order.
- * @return a binary output stream with the specified byte order.
+ * @return A binary output stream with the specified byte order.
* @throws UnsupportedOperationException if the byte order is not
supported.
*/
@SuppressWarnings("resource")
@@ -62,7 +62,7 @@ public abstract class AbstractBinaryOutputStream extends
FilterOutputStream {
* Creates a little-endian binary output stream.
*
* @param outputStream the underlying output stream.
- * @return a little-endian binary output stream.
+ * @return A little-endian binary output stream.
*/
public static LittleEndianBinaryOutputStream littleEndian(final
OutputStream outputStream) {
return new LittleEndianBinaryOutputStream(outputStream);
diff --git a/src/main/java/org/apache/commons/imaging/common/Allocator.java
b/src/main/java/org/apache/commons/imaging/common/Allocator.java
index 75f48ef0..7df23c21 100644
--- a/src/main/java/org/apache/commons/imaging/common/Allocator.java
+++ b/src/main/java/org/apache/commons/imaging/common/Allocator.java
@@ -42,7 +42,7 @@ public final class Allocator {
* @param <T> The return array type
* @param request The requested size.
* @param factory The array factory.
- * @return a new byte array.
+ * @return A new byte array.
* @throws AllocationRequestException Thrown when the request exceeds the
limit.
* @see #check(int)
*/
@@ -57,7 +57,7 @@ public final class Allocator {
* @param request The requested size.
* @param factory The array factory.
* @param eltShallowByteSize The shallow byte size of an element.
- * @return a new byte array.
+ * @return A new byte array.
* @throws AllocationRequestException Thrown when the request exceeds the
limit.
* @see #check(int)
*/
@@ -71,7 +71,7 @@ public final class Allocator {
*
* @param <T> The return array type
* @param request The requested size.
- * @return a new byte array.
+ * @return A new byte array.
* @throws AllocationRequestException Thrown when the request exceeds the
limit.
* @see #check(int)
*/
@@ -84,7 +84,7 @@ public final class Allocator {
* Allocates a byte array of the requested size.
*
* @param request The requested size.
- * @return a new byte array.
+ * @return A new byte array.
* @throws AllocationRequestException Thrown when the request exceeds the
limit.
* @see #check(int, int)
*/
@@ -96,7 +96,7 @@ public final class Allocator {
* Allocates a byte array of the requested size.
*
* @param request The requested size is cast down to an int.
- * @return a new byte array.
+ * @return A new byte array.
* @throws AllocationRequestException Thrown when the request exceeds the
limit.
* @see #check(int, int)
*/
@@ -108,7 +108,7 @@ public final class Allocator {
* Allocates a char array of the requested size.
*
* @param request The requested size.
- * @return a new char array.
+ * @return A new char array.
* @throws AllocationRequestException Thrown when the request exceeds the
limit.
* @see #check(int, int)
*/
@@ -190,7 +190,7 @@ public final class Allocator {
* Allocates a double array of the requested size.
*
* @param request The requested size.
- * @return a new double array.
+ * @return A new double array.
* @throws AllocationRequestException Thrown when the request exceeds the
limit.
* @see #check(int, int)
*/
@@ -202,7 +202,7 @@ public final class Allocator {
* Allocates a float array of the requested size.
*
* @param request The requested size.
- * @return a new float array.
+ * @return A new float array.
* @throws AllocationRequestException Thrown when the request exceeds the
limit.
* @see #check(int, int)
*/
@@ -214,7 +214,7 @@ public final class Allocator {
* Allocates a int array of the requested size.
*
* @param request The requested size.
- * @return a new int array.
+ * @return A new int array.
* @throws AllocationRequestException Thrown when the request exceeds the
limit.
* @see #check(int, int)
*/
@@ -226,7 +226,7 @@ public final class Allocator {
* Allocates a long array of the requested size.
*
* @param request The requested size.
- * @return a new long array.
+ * @return A new long array.
* @throws AllocationRequestException Thrown when the request exceeds the
limit.
* @see #check(int, int)
*/
@@ -238,7 +238,7 @@ public final class Allocator {
* Allocates a short array of the requested size.
*
* @param request The requested size.
- * @return a new short array.
+ * @return A new short array.
* @throws AllocationRequestException Thrown when the request exceeds the
limit.
* @see #check(int, int)
*/
diff --git
a/src/main/java/org/apache/commons/imaging/common/BinaryFunctions.java
b/src/main/java/org/apache/commons/imaging/common/BinaryFunctions.java
index 20430ad5..e0cea3c3 100644
--- a/src/main/java/org/apache/commons/imaging/common/BinaryFunctions.java
+++ b/src/main/java/org/apache/commons/imaging/common/BinaryFunctions.java
@@ -81,7 +81,7 @@ public final class BinaryFunctions {
* @param original the array from which a range is to be copied.
* @param from the initial index of the range to be copied, inclusive.
* @param count the amount of bytes to copy.
- * @return a new array containing the specified range from the original
array, truncated or padded with zeros to obtain the required length.
+ * @return A new array containing the specified range from the original
array, truncated or padded with zeros to obtain the required length.
*/
public static byte[] copyOfRange(final byte[] original, final int from,
final int count) {
return Arrays.copyOfRange(original, from, from +
Allocator.checkByteArray(count));
@@ -92,7 +92,7 @@ public final class BinaryFunctions {
*
* @param original the array from which a range is to be copied.
* @param count the amount of bytes to copy.
- * @return a new array containing the specified range from the original
array, truncated or padded with zeros to obtain the required length.
+ * @return A new array containing the specified range from the original
array, truncated or padded with zeros to obtain the required length.
*/
public static byte[] copyOfStart(final byte[] original, int count) {
if (count > original.length) {
@@ -185,7 +185,7 @@ public final class BinaryFunctions {
* Convert a quad into a byte array.
*
* @param quad quad.
- * @return a byte array.
+ * @return A byte array.
*/
public static byte[] quadsToByteArray(final int quad) {
final byte[] arr = new byte[4];
@@ -281,7 +281,7 @@ public final class BinaryFunctions {
* @param in a valid input stream
* @param exception application-defined message to be used for
constructing an exception if an error condition is triggered.
* @param byteOrder the order in which the InputStream marshals data
- * @return a long integer interpreted from next 8 bytes in the InputStream
+ * @return A long integer interpreted from next 8 bytes in the InputStream
* @throws IOException in the event of a non-recoverable error, such as an
attempt to read past the end of file.
*/
public static long read8Bytes(final String name, final InputStream in,
final String exception, final ByteOrder byteOrder) throws IOException {
diff --git
a/src/main/java/org/apache/commons/imaging/common/BufferedImageFactory.java
b/src/main/java/org/apache/commons/imaging/common/BufferedImageFactory.java
index d693e3fe..dfe6d90f 100644
--- a/src/main/java/org/apache/commons/imaging/common/BufferedImageFactory.java
+++ b/src/main/java/org/apache/commons/imaging/common/BufferedImageFactory.java
@@ -30,7 +30,7 @@ public interface BufferedImageFactory {
* @param width the image width.
* @param height the image height.
* @param hasAlpha whether the image has an alpha channel.
- * @return a new BufferedImage.
+ * @return A new BufferedImage.
*/
BufferedImage getColorBufferedImage(int width, int height, boolean
hasAlpha);
@@ -40,7 +40,7 @@ public interface BufferedImageFactory {
* @param width the image width.
* @param height the image height.
* @param hasAlpha whether the image has an alpha channel.
- * @return a new BufferedImage.
+ * @return A new BufferedImage.
*/
BufferedImage getGrayscaleBufferedImage(int width, int height, boolean
hasAlpha);
}
diff --git
a/src/main/java/org/apache/commons/imaging/common/ByteConversions.java
b/src/main/java/org/apache/commons/imaging/common/ByteConversions.java
index 3f63ddf1..7c18cdb2 100644
--- a/src/main/java/org/apache/commons/imaging/common/ByteConversions.java
+++ b/src/main/java/org/apache/commons/imaging/common/ByteConversions.java
@@ -177,7 +177,7 @@ public final class ByteConversions {
*
* @param value a standard data primitive of type long.
* @param byteOrder the byte order to be used for encoding.
- * @return an array of length 8.
+ * @return An array of length 8.
*/
public static byte[] toBytes(final long value, final ByteOrder byteOrder) {
final byte[] result = new byte[8];
@@ -446,7 +446,7 @@ public final class ByteConversions {
*
* @param bytes an array of size at least 8
* @param byteOrder the byte-order for interpreting the input bytes
- * @return an eight-byte signed integer
+ * @return An eight-byte signed integer
*/
public static long toLong(final byte[] bytes, final ByteOrder byteOrder) {
return toLong(bytes, 0, byteOrder);
@@ -474,7 +474,7 @@ public final class ByteConversions {
*
* @param bytes a valid array
* @param byteOrder the byte-order for interpreting the input bytes
- * @return an array of zero or more eight-byte signed integers
+ * @return An array of zero or more eight-byte signed integers
*/
public static long[] toLongs(final byte[] bytes, final ByteOrder
byteOrder) {
return toLongs(bytes, 0, bytes.length, byteOrder);
@@ -492,7 +492,7 @@ public final class ByteConversions {
* @param bytes a valid array dimensioned to at least 8.
* @param byteOrder the byte order for integer conversion
* @param unsignedType indicates whether the extracted value is an
unsigned type.
- * @return a valid instance
+ * @return A valid instance
*/
public static RationalNumber toRational(final byte[] bytes, final
ByteOrder byteOrder, final boolean unsignedType) {
return toRational(bytes, 0, byteOrder, unsignedType);
diff --git a/src/main/java/org/apache/commons/imaging/common/ImageBuilder.java
b/src/main/java/org/apache/commons/imaging/common/ImageBuilder.java
index 294c2885..bd65b72d 100644
--- a/src/main/java/org/apache/commons/imaging/common/ImageBuilder.java
+++ b/src/main/java/org/apache/commons/imaging/common/ImageBuilder.java
@@ -141,7 +141,7 @@ public final class ImageBuilder {
/**
* Create a BufferedImage using the data stored in the ImageBuilder.
*
- * @return a valid BufferedImage.
+ * @return A valid BufferedImage.
*/
public BufferedImage getBufferedImage() {
return makeBufferedImage(data, width, height, hasAlpha);
@@ -150,7 +150,7 @@ public final class ImageBuilder {
/**
* Gets the height of the ImageBuilder pixel field
*
- * @return a positive integer
+ * @return A positive integer
*/
public int getHeight() {
return height;
@@ -178,7 +178,7 @@ public final class ImageBuilder {
* @param y the Y coordinate of the upper-left corner of the specified
rectangular region
* @param w the width of the specified rectangular region
* @param h the height of the specified rectangular region
- * @return a BufferedImage that constructed from the data within the
specified rectangular region
+ * @return A BufferedImage that constructed from the data within the
specified rectangular region
* @throws RasterFormatException f the specified area is not contained
within this ImageBuilder
*/
public BufferedImage getSubimage(final int x, final int y, final int w,
final int h) {
@@ -207,7 +207,7 @@ public final class ImageBuilder {
* @param y the Y coordinate of the upper-left corner of the specified
rectangular region
* @param w the width of the specified rectangular region
* @param h the height of the specified rectangular region
- * @return a valid instance of the specified width and height.
+ * @return A valid instance of the specified width and height.
* @throws RasterFormatException if the specified area is not contained
within this ImageBuilder
*/
public ImageBuilder getSubset(final int x, final int y, final int w, final
int h) {
@@ -224,7 +224,7 @@ public final class ImageBuilder {
/**
* Gets the width of the ImageBuilder pixel field
*
- * @return a positive integer
+ * @return A positive integer
*/
public int getWidth() {
return width;
diff --git
a/src/main/java/org/apache/commons/imaging/common/RationalNumber.java
b/src/main/java/org/apache/commons/imaging/common/RationalNumber.java
index 46fc9308..2387183a 100644
--- a/src/main/java/org/apache/commons/imaging/common/RationalNumber.java
+++ b/src/main/java/org/apache/commons/imaging/common/RationalNumber.java
@@ -257,7 +257,7 @@ public class RationalNumber extends Number {
* non-zero common divisor exists. However, if no such divisor exists,
there is no numerically correct way to perform the negation. When a negation
cannot
* be performed correctly, this method throws an unchecked exception.
*
- * @return a valid instance with a negated value.
+ * @return A valid instance with a negated value.
*/
public RationalNumber negate() {
long n = numerator;
diff --git
a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcBlock.java
b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcBlock.java
index 48c154e8..5cd227d9 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcBlock.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcBlock.java
@@ -46,7 +46,7 @@ public class IptcBlock {
/**
* Gets a copy of the block data.
*
- * @return a copy of the block data bytes.
+ * @return A copy of the block data bytes.
*/
public byte[] getBlockData() {
return blockData.clone();
@@ -55,7 +55,7 @@ public class IptcBlock {
/**
* Gets a copy of the block name bytes.
*
- * @return a copy of the block name bytes.
+ * @return A copy of the block name bytes.
*/
public byte[] getBlockNameBytes() {
return blockNameBytes.clone();
diff --git
a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcParser.java
b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcParser.java
index e326a04f..718cb852 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcParser.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcParser.java
@@ -117,7 +117,7 @@ public class IptcParser extends BinaryFileParser {
*
* @param bytes the byte array containing IPTC data.
* @param strict whether to use strict parsing mode.
- * @return a list of IPTC blocks.
+ * @return A list of IPTC blocks.
* @throws ImagingException if an imaging error occurs.
* @throws IOException if an I/O error occurs.
*/
@@ -219,7 +219,7 @@ public class IptcParser extends BinaryFileParser {
* Parses IPTC records from a block of bytes.
*
* @param bytes the byte array containing IPTC data.
- * @return a list of IPTC records.
+ * @return A list of IPTC records.
*/
protected List<IptcRecord> parseIptcBlock(final byte[] bytes) {
Charset charset = DEFAULT_CHARSET;
diff --git
a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcTypes.java
b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcTypes.java
index 0dd6332f..63d79f7f 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcTypes.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcTypes.java
@@ -196,7 +196,7 @@ public enum IptcTypes implements IptcType {
* Gets an unknown IPTC type for the specified type number.
*
* @param type the type number.
- * @return an unknown IPTC type.
+ * @return An unknown IPTC type.
*/
public static IptcType getUnknown(final int type) {
return new IptcType() {
diff --git
a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/ComSegment.java
b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/ComSegment.java
index 61e3e2aa..95439214 100644
---
a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/ComSegment.java
+++
b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/ComSegment.java
@@ -50,7 +50,7 @@ public class ComSegment extends AbstractGenericSegment {
/**
* Returns a copy of the comment.
*
- * @return a copy of the comment's bytes
+ * @return A copy of the comment's bytes
*/
public byte[] getComment() {
return getSegmentData();
diff --git
a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunk.java
b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunk.java
index e6bf3203..ff66546a 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunk.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunk.java
@@ -103,7 +103,7 @@ public class PngChunk extends BinaryFileParser {
* The caller is responsible for closing the resource.
* </p>
*
- * @return a ByteArrayInputStream for the chunk bytes
+ * @return A ByteArrayInputStream for the chunk bytes
*/
protected ByteArrayInputStream getDataStream() {
return new ByteArrayInputStream(bytes);
diff --git
a/src/main/java/org/apache/commons/imaging/formats/png/transparencyfilters/AbstractTransparencyFilter.java
b/src/main/java/org/apache/commons/imaging/formats/png/transparencyfilters/AbstractTransparencyFilter.java
index 8dfbe2b4..706f91db 100644
---
a/src/main/java/org/apache/commons/imaging/formats/png/transparencyfilters/AbstractTransparencyFilter.java
+++
b/src/main/java/org/apache/commons/imaging/formats/png/transparencyfilters/AbstractTransparencyFilter.java
@@ -52,7 +52,7 @@ public abstract class AbstractTransparencyFilter extends
BinaryFileParser {
* Gets the byte at the given offset.
*
* @param offset offset.
- * @return a byte.
+ * @return A byte.
*/
public byte getByte(final int offset) {
return bytes[offset];
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffImageData.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffImageData.java
index fdc1cd80..dea7b212 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffImageData.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffImageData.java
@@ -160,7 +160,7 @@ public abstract class AbstractTiffImageData {
* Gets the height of individual tiles. Note that if the overall image
height is not a multiple of the tile height, then the last row of tiles may
* extend beyond the image height.
*
- * @return an integer value greater than zero.
+ * @return An integer value greater than zero.
*/
public int getTileHeight() {
return tileLength;
@@ -170,7 +170,7 @@ public abstract class AbstractTiffImageData {
* Gets the width of individual tiles. Note that if the overall image
width is not a multiple of the tile width, then the last column of tiles may
* extend beyond the image width.
*
- * @return an integer value greater than zero.
+ * @return An integer value greater than zero.
*/
public int getTileWidth() {
return tileWidth;
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffRasterData.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffRasterData.java
index 05ebcd6b..d1147b17 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffRasterData.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffRasterData.java
@@ -105,7 +105,7 @@ public abstract class AbstractTiffRasterData {
/**
* Gets the raster data type from the instance.
*
- * @return a valid enumeration value.
+ * @return A valid enumeration value.
*/
public abstract TiffRasterDataType getDataType();
@@ -153,7 +153,7 @@ public abstract class AbstractTiffRasterData {
/**
* Gets the number of samples per pixel.
*
- * @return a value of 1 or greater.
+ * @return A value of 1 or greater.
*/
public final int getSamplesPerPixel() {
return samplesPerPixel;
@@ -162,7 +162,7 @@ public abstract class AbstractTiffRasterData {
/**
* Tabulates simple statistics for the raster and returns an instance
containing general metadata.
*
- * @return a valid instance containing a safe copy of the current simple
statistics for the raster.
+ * @return A valid instance containing a safe copy of the current simple
statistics for the raster.
*/
public abstract TiffRasterStatistics getSimpleStatistics();
@@ -170,7 +170,7 @@ public abstract class AbstractTiffRasterData {
* Tabulates simple statistics for the raster excluding the specified
value and returns an instance containing general metadata.
*
* @param valueToExclude exclude samples with this specified value.
- * @return a valid instance.
+ * @return A valid instance.
*/
public abstract TiffRasterStatistics getSimpleStatistics(float
valueToExclude);
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffDirectory.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffDirectory.java
index 153f6038..12b96f24 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffDirectory.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffDirectory.java
@@ -902,7 +902,7 @@ public class TiffDirectory extends AbstractTiffElement
implements Iterable<TiffF
* </pre>
*
* @param params an optional parameter map instance.
- * @return a valid instance.
+ * @return A valid instance.
* @throws ImagingException in the event of incompatible or malformed data.
* @throws IOException in the event of an I/O error.
*/
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffField.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffField.java
index 6c1006dd..de5b4256 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffField.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffField.java
@@ -378,7 +378,7 @@ public class TiffField {
/**
* Gets the value of the field in the form of an array of eight-byte
(long) integers.
*
- * @return an valid array of size zero or larger giving signed long
integer values.
+ * @return An valid array of size zero or larger giving signed long
integer values.
* @throws ImagingException if the field instance is of an incompatible
type or does not contain a valid data element.
*/
public long[] getLongArrayValue() throws ImagingException {
@@ -415,7 +415,7 @@ public class TiffField {
/**
* Gets the value of the field in the form of an eight-byte (long) integer.
*
- * @return a signed long integer value.
+ * @return A signed long integer value.
* @throws ImagingException if the field instance is of an incompatible
type or does not contain a valid data element.
*/
public long getLongValue() throws ImagingException {
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImageParser.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImageParser.java
index 84fec928..aa9ab9e0 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImageParser.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImageParser.java
@@ -719,7 +719,7 @@ public class TiffImageParser extends
AbstractImageParser<TiffImagingParameters>
* @param directory the TIFF directory pointing to the data to be
extracted (TIFF files may contain multiple directories)
* @param byteOrder the byte order of the data to be extracted
* @param params an optional parameter object instance
- * @return a valid instance
+ * @return A valid instance
* @throws ImagingException in the event of incompatible or malformed data
* @throws IOException in the event of an I/O error
*/
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImagingParameters.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImagingParameters.java
index cfeb2b33..72cbf600 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImagingParameters.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImagingParameters.java
@@ -172,7 +172,7 @@ public class TiffImagingParameters extends
XmpImagingParameters<TiffImagingParam
/**
* Gets the X coordinate of a sub-image. This setting is meaningful only
if a sub-image is set.
*
- * @return a positive integer
+ * @return A positive integer
*/
public int getSubImageX() {
return subImageX;
@@ -181,7 +181,7 @@ public class TiffImagingParameters extends
XmpImagingParameters<TiffImagingParam
/**
* Gets the Y coordinate of a sub-image. This setting is meaningful only
if a sub-image is set.
*
- * @return a positive integer
+ * @return A positive integer
*/
public int getSubImageY() {
return subImageY;
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataFloat.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataFloat.java
index 5aa2c940..be058b38 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataFloat.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataFloat.java
@@ -102,7 +102,7 @@ public final class TiffRasterDataFloat extends
AbstractTiffRasterData {
* <p>
* See the class API documentation above for notes on accessing array
elements.
*
- * @return a direct reference to the data array stored in this instance.
+ * @return A direct reference to the data array stored in this instance.
*/
@Override
public float[] getData() {
@@ -112,7 +112,7 @@ public final class TiffRasterDataFloat extends
AbstractTiffRasterData {
/**
* Gets the raster data type from the instance.
*
- * @return a value of TiffRasterDataType.FLOAT.
+ * @return A value of TiffRasterDataType.FLOAT.
*/
@Override
public TiffRasterDataType getDataType() {
@@ -159,7 +159,7 @@ public final class TiffRasterDataFloat extends
AbstractTiffRasterData {
/**
* Tabulates simple statistics for the raster and returns an instance
containing general metadata.
*
- * @return a valid instance containing a safe copy of the current simple
statistics for the raster.
+ * @return A valid instance containing a safe copy of the current simple
statistics for the raster.
*/
@Override
public TiffRasterStatistics getSimpleStatistics() {
@@ -170,7 +170,7 @@ public final class TiffRasterDataFloat extends
AbstractTiffRasterData {
* Tabulates simple statistics for the raster excluding the specified
value and returns an instance containing general metadata.
*
* @param valueToExclude exclude samples with this specified value.
- * @return a valid instance.
+ * @return A valid instance.
*/
@Override
public TiffRasterStatistics getSimpleStatistics(final float
valueToExclude) {
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataInt.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataInt.java
index c1650f9c..07f1aa20 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataInt.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataInt.java
@@ -110,7 +110,7 @@ public final class TiffRasterDataInt extends
AbstractTiffRasterData {
/**
* Gets the raster data type from the instance.
*
- * @return a value of TiffRasterDataType.FLOAT.
+ * @return A value of TiffRasterDataType.FLOAT.
*/
@Override
public TiffRasterDataType getDataType() {
@@ -123,7 +123,7 @@ public final class TiffRasterDataInt extends
AbstractTiffRasterData {
* performance and memory conservation. TIFF images that contain
floating-point data are often quite large. Sizes of 100 million raster cells
are common.
* Making a redundant copy of such a large in-memory object might exceed
the resources available to a Java application.
*
- * @return a direct reference to the data array stored in this instance.
+ * @return A direct reference to the data array stored in this instance.
*/
@Override
public int[] getIntData() {
@@ -158,7 +158,7 @@ public final class TiffRasterDataInt extends
AbstractTiffRasterData {
/**
* Tabulates simple statistics for the raster and returns an instance
containing general metadata.
*
- * @return a valid instance containing a safe copy of the current simple
statistics for the raster.
+ * @return A valid instance containing a safe copy of the current simple
statistics for the raster.
*/
@Override
public TiffRasterStatistics getSimpleStatistics() {
@@ -169,7 +169,7 @@ public final class TiffRasterDataInt extends
AbstractTiffRasterData {
* Tabulates simple statistics for the raster excluding the specified
value and returns an instance containing general metadata.
*
* @param valueToExclude exclude samples with this specified value.
- * @return a valid instance.
+ * @return A valid instance.
*/
@Override
public TiffRasterStatistics getSimpleStatistics(final float
valueToExclude) {
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/constants/GpsTagConstants.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/constants/GpsTagConstants.java
index 678a5dc6..fe4c43a6 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/constants/GpsTagConstants.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/constants/GpsTagConstants.java
@@ -231,7 +231,7 @@ public final class GpsTagConstants {
/**
* Gets the GPS version.
*
- * @return a copy of the GPS version byte array.
+ * @return A copy of the GPS version byte array.
*/
public static byte[] gpsVersion() {
return GPS_VERSION.clone();
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/constants/TiffPlanarConfiguration.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/constants/TiffPlanarConfiguration.java
index 1d2ae460..dc0341ad 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/constants/TiffPlanarConfiguration.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/constants/TiffPlanarConfiguration.java
@@ -35,7 +35,7 @@ public enum TiffPlanarConfiguration {
* Interprets an integer code value to determine the enumerated value.
Implements lenient rules for handling non-compliant values.
*
* @param codeValue an integer code corresponding to the TIFF
specification.
- * @return a valid enumeration.
+ * @return A valid enumeration.
*/
public static TiffPlanarConfiguration lenientValueOf(final int codeValue) {
switch (codeValue) {
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/datareaders/AbstractImageDataReader.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/datareaders/AbstractImageDataReader.java
index 112f4c2b..259c8f29 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/datareaders/AbstractImageDataReader.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/datareaders/AbstractImageDataReader.java
@@ -363,7 +363,7 @@ public abstract class AbstractImageDataReader {
* @param subImageSpecification a rectangle describing a sub-region of the
image for reading, or a null if the whole image is to be read.
* @param hasAlpha indicates that the image has an alpha
(transparency) channel (RGB color model only).
* @param isAlphaPremultiplied indicates that the image uses the
associated alpha channel format (pre-multiplied alpha).
- * @return a valid instance containing the pixel data from the image.
+ * @return A valid instance containing the pixel data from the image.
* @throws IOException in the event of an unrecoverable I/O error.
* @throws ImagingException TODO
*/
@@ -375,7 +375,7 @@ public abstract class AbstractImageDataReader {
* DataReaderTiled assume that this instance is of a compatible data type
(floating-point) and that all access checks have already been performed.
*
* @param subImage if non-null, instructs the access method to retrieve
only a sub-section of the image data.
- * @return a valid instance
+ * @return A valid instance
* @throws ImagingException in the event of an incompatible data form.
* @throws IOException in the event of I/O error.
*/
@@ -599,7 +599,7 @@ public abstract class AbstractImageDataReader {
* @param bytes the raw bytes.
* @param bitsPerPixel the number of bits per sample, 32 or 64.
* @param byteOrder the byte order for the source data.
- * @return a valid array of integers in row major order, dimensions
scan-size wide and height.
+ * @return A valid array of integers in row major order, dimensions
scan-size wide and height.
* @throws ImagingException in the event of an invalid format.
*/
protected int[] unpackFloatingPointSamples(final int width, final int
height, final int scanSize, final byte[] bytes, final int bitsPerPixel,
@@ -757,7 +757,7 @@ public abstract class AbstractImageDataReader {
* @param predictor the predictor specified by the source, only
predictor 3 is supported.
* @param bitsPerSample the number of bits per sample, 32 or 64.
* @param byteOrder the byte order for the source data
- * @return a valid array of integers in row major order, dimensions
scan-size wide and height.
+ * @return A valid array of integers in row major order, dimensions
scan-size wide and height.
*/
protected int[] unpackIntSamples(final int width, final int height, final
int scanSize, final byte[] bytes, final int predictor, final int bitsPerSample,
final ByteOrder byteOrder) {
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/AbstractFieldType.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/AbstractFieldType.java
index b466cb1c..ec64b0a6 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/AbstractFieldType.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/AbstractFieldType.java
@@ -236,7 +236,7 @@ public abstract class AbstractFieldType {
*
* @param obj input.
* @param byteOrder output byte order; not used by all subclasses.
- * @return a byte array.
+ * @return A byte array.
* @throws ImagingException Thrown on a bad input.
*/
public abstract byte[] writeData(Object obj, ByteOrder byteOrder) throws
ImagingException;
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeLong8.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeLong8.java
index cd506151..0f962508 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeLong8.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeLong8.java
@@ -42,7 +42,7 @@ public class FieldTypeLong8 extends AbstractFieldType {
* Gets the value(s) for this field in the form of an array of long
integers.
*
* @param entry the TIFF field as obtained from the source file.
- * @return a valid, potentially empty array of Java long integers.
+ * @return A valid, potentially empty array of Java long integers.
*/
@Override
public Object getValue(final TiffField entry) {
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/floatingpoint/PaletteEntry.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/floatingpoint/PaletteEntry.java
index 2beb1265..0288151b 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/floatingpoint/PaletteEntry.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/floatingpoint/PaletteEntry.java
@@ -35,7 +35,7 @@ public interface PaletteEntry {
* value is undefined (though the value zero is often used).
*
* @param f valid floating point value, or a NaN.
- * @return an integer value
+ * @return An integer value
*/
int getArgb(float f);
@@ -44,7 +44,7 @@ public interface PaletteEntry {
* undefined (though a null return is often used).
*
* @param f a valid floating point value, or a NaN.
- * @return a valid color instance or, potentially, a null if the floating
point input is not within the covered range.
+ * @return A valid color instance or, potentially, a null if the floating
point input is not within the covered range.
*/
Color getColor(float f);
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/floatingpoint/PhotometricInterpreterFloat.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/floatingpoint/PhotometricInterpreterFloat.java
index 7b2f7b82..49a7b1fa 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/floatingpoint/PhotometricInterpreterFloat.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/floatingpoint/PhotometricInterpreterFloat.java
@@ -149,7 +149,7 @@ public final class PhotometricInterpreterFloat extends
AbstractPhotometricInterp
/**
* Gets the coordinates (x, y) at which the maximum value was identified
during processing
*
- * @return a valid array of length 2.
+ * @return A valid array of length 2.
*/
public int[] getMaxXY() {
return new int[] { xMax, yMax };
@@ -179,7 +179,7 @@ public final class PhotometricInterpreterFloat extends
AbstractPhotometricInterp
/**
* Gets the coordinates (x, y) at which the minimum value was identified
during processing
*
- * @return a valid array of length 2.
+ * @return A valid array of length 2.
*/
public int[] getMinXY() {
return new int[] { xMin, yMin };
@@ -240,7 +240,7 @@ public final class PhotometricInterpreterFloat extends
AbstractPhotometricInterp
* provided as a convenience to applications that are processing data
outside the standard TIFF image-reading modules.
*
* @param f the floating point value to be mapped to an ARGB value
- * @return a valid ARGB value, or zero if no palette specification covers
the input value.
+ * @return A valid ARGB value, or zero if no palette specification covers
the input value.
*/
public int mapValueToArgb(final float f) {
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/write/AbstractTiffImageWriter.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/write/AbstractTiffImageWriter.java
index 2c3a1cca..6fec0b04 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/write/AbstractTiffImageWriter.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/write/AbstractTiffImageWriter.java
@@ -220,7 +220,7 @@ public abstract class AbstractTiffImageWriter {
* Validates the TIFF output set directories and returns a summary.
*
* @param outputSet the output set to validate.
- * @return a summary of the output set.
+ * @return A summary of the output set.
* @throws ImagingException if the directories are invalid.
*/
protected TiffOutputSummary validateDirectories(final TiffOutputSet
outputSet) throws ImagingException {
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputDirectory.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputDirectory.java
index dc49406c..3c530902 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputDirectory.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputDirectory.java
@@ -710,7 +710,7 @@ public final class TiffOutputDirectory extends
AbstractTiffOutputItem implements
/**
* Gets all fields in this directory.
*
- * @return a list of all fields.
+ * @return A list of all fields.
*/
public List<TiffOutputField> getFields() {
return new ArrayList<>(fields);
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputField.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputField.java
index 454f3247..0de46c6d 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputField.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputField.java
@@ -109,7 +109,7 @@ public class TiffOutputField {
/**
* Return a copy of the data in this TIFF output field.
*
- * @return a copy of the data in this TIFF output field.
+ * @return A copy of the data in this TIFF output field.
*/
public byte[] getData() {
return Arrays.copyOf(this.bytes, this.bytes.length);
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputSet.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputSet.java
index ac7cad1d..9374c800 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputSet.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffOutputSet.java
@@ -174,7 +174,7 @@ public final class TiffOutputSet implements
Iterable<TiffOutputDirectory> {
/**
* Gets a list of all directories in this output set.
*
- * @return a list of all directories.
+ * @return A list of all directories.
*/
public List<TiffOutputDirectory> getDirectories() {
return new ArrayList<>(directories);
diff --git
a/src/main/java/org/apache/commons/imaging/formats/webp/chunks/AbstractWebPChunk.java
b/src/main/java/org/apache/commons/imaging/formats/webp/chunks/AbstractWebPChunk.java
index 66904782..618676b1 100644
---
a/src/main/java/org/apache/commons/imaging/formats/webp/chunks/AbstractWebPChunk.java
+++
b/src/main/java/org/apache/commons/imaging/formats/webp/chunks/AbstractWebPChunk.java
@@ -87,7 +87,7 @@ public abstract class AbstractWebPChunk extends
BinaryFileParser {
/**
* Gets a copy of the chunk data as bytes.
*
- * @return a copy of the chunk data as bytes.
+ * @return A copy of the chunk data as bytes.
*/
public byte[] getBytes() {
return bytes.clone();
diff --git a/src/main/java/org/apache/commons/imaging/icc/IccProfileInfo.java
b/src/main/java/org/apache/commons/imaging/icc/IccProfileInfo.java
index 193f6fd8..0eebbea8 100644
--- a/src/main/java/org/apache/commons/imaging/icc/IccProfileInfo.java
+++ b/src/main/java/org/apache/commons/imaging/icc/IccProfileInfo.java
@@ -129,7 +129,7 @@ public class IccProfileInfo {
/**
* Gets a copy of the raw profile data.
*
- * @return a copy of the profile data bytes.
+ * @return A copy of the profile data bytes.
*/
public byte[] getData() {
return data.clone();
@@ -138,7 +138,7 @@ public class IccProfileInfo {
/**
* Gets a copy of the profile ID.
*
- * @return a copy of the profile ID bytes.
+ * @return A copy of the profile ID bytes.
*/
public byte[] getProfileId() {
return profileId.clone();
@@ -179,7 +179,7 @@ public class IccProfileInfo {
* Gets a string representation of this ICC profile information with a
prefix.
*
* @param prefix the prefix to use for output lines.
- * @return a string representation of the profile information.
+ * @return A string representation of the profile information.
* @throws ImagingException if an imaging error occurs.
* @throws IOException if an I/O error occurs.
*/
diff --git a/src/main/java/org/apache/commons/imaging/palette/ColorGroup.java
b/src/main/java/org/apache/commons/imaging/palette/ColorGroup.java
index 9d07a6d3..04a311dc 100644
--- a/src/main/java/org/apache/commons/imaging/palette/ColorGroup.java
+++ b/src/main/java/org/apache/commons/imaging/palette/ColorGroup.java
@@ -103,7 +103,7 @@ final class ColorGroup {
/**
* Gets a copy of the list of color counts.
*
- * @return a copy of the list of color counts
+ * @return A copy of the list of color counts
*/
List<ColorCount> getColorCounts() {
return new ArrayList<>(colorCounts);
diff --git
a/src/main/java/org/apache/commons/imaging/palette/MedianCutQuantizer.java
b/src/main/java/org/apache/commons/imaging/palette/MedianCutQuantizer.java
index a284f12a..1d071aed 100644
--- a/src/main/java/org/apache/commons/imaging/palette/MedianCutQuantizer.java
+++ b/src/main/java/org/apache/commons/imaging/palette/MedianCutQuantizer.java
@@ -46,7 +46,7 @@ public class MedianCutQuantizer {
*
* @param image the image to quantize.
* @param maxColors the maximum number of colors in the result.
- * @return a map of colors to their counts.
+ * @return A map of colors to their counts.
*/
public Map<Integer, ColorCount> groupColors(final BufferedImage image,
final int maxColors) {
final int max = Integer.MAX_VALUE;
diff --git
a/src/test/java/org/apache/commons/imaging/examples/tiff/ReadTagsAndImages.java
b/src/test/java/org/apache/commons/imaging/examples/tiff/ReadTagsAndImages.java
index cad3beaf..57486076 100644
---
a/src/test/java/org/apache/commons/imaging/examples/tiff/ReadTagsAndImages.java
+++
b/src/test/java/org/apache/commons/imaging/examples/tiff/ReadTagsAndImages.java
@@ -162,7 +162,7 @@ public class ReadTagsAndImages {
* @param asciiParameters the content of TIFF Tag ID=34737.
* @param pos the position of the sub-string within the content
* @param len the length of the sub-string.
- * @return a valid string.
+ * @return A valid string.
*/
private static String extractAscii(final String asciiParameters, final int
pos, final int len) {
if (asciiParameters != null && len > 0 && pos + len <=
asciiParameters.length()) {
@@ -179,7 +179,7 @@ public class ReadTagsAndImages {
* @param doubleParameters an array of values
* @param pos the starting position of the values for the
GeoKey
* @param len the number of values for the GeoKey
- * @return a formatted string.
+ * @return A formatted string.
*/
private static String extractDouble(final double[] doubleParameters, final
int pos, final int len) {
if (doubleParameters != null && doubleParameters.length >= pos + len) {
@@ -208,7 +208,7 @@ public class ReadTagsAndImages {
* @param valueOrPosition a single integer value or the position within
the associated floating point array
* @param doubleParameters an array of doubles
* @param asciiParameters a String consisting of ASCII characters.
- * @return a valid string, potentially a note to see the specification if
a more useful description is not available.
+ * @return A valid string, potentially a note to see the specification if
a more useful description is not available.
*/
private static String interpretElements(final GeoKey geoKey, final int
ref, final int len, final int valueOrPosition, final double[] doubleParameters,
final String asciiParameters) {
diff --git
a/src/test/java/org/apache/commons/imaging/examples/tiff/SurveyTiffFile.java
b/src/test/java/org/apache/commons/imaging/examples/tiff/SurveyTiffFile.java
index eb062feb..09dca2d4 100644
--- a/src/test/java/org/apache/commons/imaging/examples/tiff/SurveyTiffFile.java
+++ b/src/test/java/org/apache/commons/imaging/examples/tiff/SurveyTiffFile.java
@@ -54,7 +54,7 @@ public class SurveyTiffFile {
*
* @param maxPathLen the maximum length of a file path (used if csv option
is not set)
* @param csv true if formatting is configured for
comma-separated-value files.
- * @return a valid string.
+ * @return A valid string.
*/
String formatHeader(final int maxPathLen, final boolean csv) {
// After some false starts, it turned out that the easiest
@@ -257,7 +257,7 @@ public class SurveyTiffFile {
* Reformats the header inserting commas and removing spaces
*
* @param s a valid string
- * @return a header suitable for a CSV file.
+ * @return A header suitable for a CSV file.
*/
private String reformatHeaderForCsv(final String s) {
final StringBuilder sb = new StringBuilder(s.length());
diff --git
a/src/test/java/org/apache/commons/imaging/formats/png/PngWritePredictorTest.java
b/src/test/java/org/apache/commons/imaging/formats/png/PngWritePredictorTest.java
index 516d19ec..6ebee147 100644
---
a/src/test/java/org/apache/commons/imaging/formats/png/PngWritePredictorTest.java
+++
b/src/test/java/org/apache/commons/imaging/formats/png/PngWritePredictorTest.java
@@ -45,7 +45,7 @@ class PngWritePredictorTest {
/**
* Populate an integer pixel array for a 256-by-256 image with varied
colors across the image area and a white and black line down the main diagonal.
*
- * @return a valid array of integers.
+ * @return A valid array of integers.
*/
private int[] populateARGB() {
// populate array with a blend of color components
diff --git
a/src/test/java/org/apache/commons/imaging/formats/tiff/TiffFloatingPointMultivariableTest.java
b/src/test/java/org/apache/commons/imaging/formats/tiff/TiffFloatingPointMultivariableTest.java
index 18563d1f..db145813 100644
---
a/src/test/java/org/apache/commons/imaging/formats/tiff/TiffFloatingPointMultivariableTest.java
+++
b/src/test/java/org/apache/commons/imaging/formats/tiff/TiffFloatingPointMultivariableTest.java
@@ -116,7 +116,7 @@ class TiffFloatingPointMultivariableTest extends
AbstractTiffTest {
* @param nRowsInBlock the number of rows in the Strip or Tile
* @param nColsInBlock the number of columns in the Strip or Tile
* @param byteOrder little-endian or big-endian
- * @return a valid array of equally sized array.
+ * @return A valid array of equally sized array.
*/
private byte[][] getBytesForOutput32(final int nRowsInBlock, final int
nColsInBlock, final ByteOrder byteOrder, final boolean useTiles,
final TiffPlanarConfiguration planarConfiguration) {
diff --git
a/src/test/java/org/apache/commons/imaging/formats/tiff/TiffFloatingPointReadTest.java
b/src/test/java/org/apache/commons/imaging/formats/tiff/TiffFloatingPointReadTest.java
index 4abc60cc..6b126043 100644
---
a/src/test/java/org/apache/commons/imaging/formats/tiff/TiffFloatingPointReadTest.java
+++
b/src/test/java/org/apache/commons/imaging/formats/tiff/TiffFloatingPointReadTest.java
@@ -63,7 +63,7 @@ class TiffFloatingPointReadTest {
* Gets a file from the TIFF test directory that contains floating-point
data.
*
* @param name a valid file name
- * @return a valid file reference.
+ * @return A valid file reference.
*/
private File getTiffFile(final String name) {
final File tiffFolder = new
File(ImagingTestConstants.TEST_IMAGE_FOLDER, "tiff");
diff --git
a/src/test/java/org/apache/commons/imaging/formats/tiff/TiffFloatingPointRoundTripTest.java
b/src/test/java/org/apache/commons/imaging/formats/tiff/TiffFloatingPointRoundTripTest.java
index aa1142be..0e925114 100644
---
a/src/test/java/org/apache/commons/imaging/formats/tiff/TiffFloatingPointRoundTripTest.java
+++
b/src/test/java/org/apache/commons/imaging/formats/tiff/TiffFloatingPointRoundTripTest.java
@@ -95,7 +95,7 @@ class TiffFloatingPointRoundTripTest extends AbstractTiffTest
{
* @param nRowsInBlock the number of rows in the Strip or Tile
* @param nColsInBlock the number of columns in the Strip or Tile
* @param byteOrder little-endian or big-endian
- * @return a valid array of equally sized array.
+ * @return A valid array of equally sized array.
*/
private byte[][] getBytesForOutput32(final float[] f, final int width,
final int height, final int nRowsInBlock, final int nColsInBlock,
final ByteOrder byteOrder) {
@@ -144,7 +144,7 @@ class TiffFloatingPointRoundTripTest extends
AbstractTiffTest {
* @param nRowsInBlock the number of rows in the Strip or Tile
* @param nColsInBlock the number of columns in the Strip or Tile
* @param byteOrder little-endian or big-endian
- * @return a valid array of equally sized array.
+ * @return A valid array of equally sized array.
*/
private byte[][] getBytesForOutput64(final float[] f, final int width,
final int height, final int nRowsInBlock, final int nColsInBlock,
final ByteOrder byteOrder) {
@@ -194,7 +194,7 @@ class TiffFloatingPointRoundTripTest extends
AbstractTiffTest {
* Constructs a photometric interpreter. This initialization is performed
in a dedicated method to ensure consistency throughout different phases of the
* test.
*
- * @return a valid instance.
+ * @return A valid instance.
*/
private PhotometricInterpreterFloat getPhotometricInterpreter() {
return new PhotometricInterpreterFloat(f0, f1 + 1.0e-5f);
diff --git
a/src/test/java/org/apache/commons/imaging/formats/tiff/TiffReadAlphaTest.java
b/src/test/java/org/apache/commons/imaging/formats/tiff/TiffReadAlphaTest.java
index fc6e9011..1f61e323 100644
---
a/src/test/java/org/apache/commons/imaging/formats/tiff/TiffReadAlphaTest.java
+++
b/src/test/java/org/apache/commons/imaging/formats/tiff/TiffReadAlphaTest.java
@@ -43,7 +43,7 @@ class TiffReadAlphaTest {
* Gets a file from the TIFF test directory that contains floating-point
data.
*
* @param name a valid file name
- * @return a valid file reference.
+ * @return A valid file reference.
*/
private File getTiffFile(final String name) {
final File tiffFolder = new
File(ImagingTestConstants.TEST_IMAGE_FOLDER, "tiff");
diff --git
a/src/test/java/org/apache/commons/imaging/formats/tiff/TiffRoundTripInt32Test.java
b/src/test/java/org/apache/commons/imaging/formats/tiff/TiffRoundTripInt32Test.java
index 6ff060d5..8e73bc56 100644
---
a/src/test/java/org/apache/commons/imaging/formats/tiff/TiffRoundTripInt32Test.java
+++
b/src/test/java/org/apache/commons/imaging/formats/tiff/TiffRoundTripInt32Test.java
@@ -72,7 +72,7 @@ class TiffRoundTripInt32Test extends AbstractTiffTest {
* @param nRowsInBlock the number of rows in the Strip or Tile
* @param nColsInBlock the number of columns in the Strip or Tile
* @param byteOrder little-endian or big-endian
- * @return a two-dimensional array of bytes dimensioned by the number of
blocks and samples
+ * @return A two-dimensional array of bytes dimensioned by the number of
blocks and samples
*/
private byte[][] getBytesForOutput32(final int[] s, final int width, final
int height, final int nRowsInBlock, final int nColsInBlock,
final ByteOrder byteOrder) {
diff --git
a/src/test/java/org/apache/commons/imaging/formats/tiff/TiffShortIntRoundTripTest.java
b/src/test/java/org/apache/commons/imaging/formats/tiff/TiffShortIntRoundTripTest.java
index 8849d08b..ab83a0ee 100644
---
a/src/test/java/org/apache/commons/imaging/formats/tiff/TiffShortIntRoundTripTest.java
+++
b/src/test/java/org/apache/commons/imaging/formats/tiff/TiffShortIntRoundTripTest.java
@@ -72,7 +72,7 @@ class TiffShortIntRoundTripTest extends AbstractTiffTest {
* @param nRowsInBlock the number of rows in the Strip or Tile
* @param nColsInBlock the number of columns in the Strip or Tile
* @param byteOrder little-endian or big-endian
- * @return a two-dimensional array of bytes dimensioned by the number of
blocks and samples
+ * @return A two-dimensional array of bytes dimensioned by the number of
blocks and samples
*/
private byte[][] getBytesForOutput16(final short[] s, final int width,
final int height, final int nRowsInBlock, final int nColsInBlock,
final ByteOrder byteOrder) {
