You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2026/07/11 12:49:44 UTC
(commons-imaging) branch master updated: Javadoc
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 6432fb9c Javadoc
6432fb9c is described below
commit 6432fb9cf8eac7e2426781d7bd0b7ab24475a282
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Jul 11 08:49:38 2026 -0400
Javadoc
---
.../org/apache/commons/imaging/ColorTools.java | 28 ++++----
.../org/apache/commons/imaging/ImageFormat.java | 2 +-
.../java/org/apache/commons/imaging/ImageInfo.java | 2 +-
.../java/org/apache/commons/imaging/Imaging.java | 2 +-
.../apache/commons/imaging/ImagingParameters.java | 6 +-
.../org/apache/commons/imaging/PixelDensity.java | 24 +++----
.../commons/imaging/bytesource/ByteSource.java | 20 +++---
.../commons/imaging/color/ColorConversions.java | 78 +++++++++++-----------
.../imaging/common/AllocationRequestException.java | 4 +-
.../apache/commons/imaging/common/Allocator.java | 6 +-
.../commons/imaging/common/BasicCParser.java | 12 ++--
.../commons/imaging/common/BinaryConstant.java | 6 +-
.../commons/imaging/common/BinaryFileParser.java | 2 +-
.../commons/imaging/common/BinaryFunctions.java | 28 ++++----
.../commons/imaging/common/ByteConversions.java | 46 ++++++-------
.../imaging/common/GenericImageMetadata.java | 4 +-
.../commons/imaging/common/ImageBuilder.java | 2 +-
.../commons/imaging/common/ImageMetadata.java | 6 +-
.../apache/commons/imaging/common/PackBits.java | 4 +-
.../commons/imaging/common/RationalNumber.java | 4 +-
.../imaging/common/XmpImagingParameters.java | 2 +-
.../imaging/formats/bmp/BmpImageParser.java | 2 +-
.../imaging/formats/gif/GifImageMetadata.java | 4 +-
.../imaging/formats/gif/GifImageMetadataItem.java | 8 +--
.../imaging/formats/jpeg/JpegImageMetadata.java | 12 ++--
.../imaging/formats/jpeg/JpegImageParser.java | 8 +--
.../commons/imaging/formats/jpeg/JpegUtils.java | 2 +-
.../imaging/formats/jpeg/decoder/JpegDecoder.java | 4 +-
.../formats/jpeg/decoder/JpegInputStream.java | 2 +-
.../imaging/formats/jpeg/iptc/IptcBlock.java | 2 +-
.../imaging/formats/jpeg/iptc/IptcParser.java | 10 +--
.../imaging/formats/jpeg/iptc/IptcRecord.java | 4 +-
.../imaging/formats/jpeg/iptc/IptcType.java | 4 +-
.../jpeg/segments/AbstractGenericSegment.java | 6 +-
.../formats/jpeg/segments/AbstractSegment.java | 4 +-
.../formats/jpeg/segments/App13Segment.java | 2 +-
.../formats/jpeg/segments/App14Segment.java | 2 +-
.../imaging/formats/jpeg/segments/App2Segment.java | 2 +-
.../imaging/formats/jpeg/segments/DhtSegment.java | 8 +--
.../imaging/formats/jpeg/segments/DqtSegment.java | 2 +-
.../imaging/formats/jpeg/segments/SofnSegment.java | 4 +-
.../imaging/formats/jpeg/segments/SosSegment.java | 2 +-
.../imaging/formats/jpeg/xmp/JpegRewriter.java | 20 +++---
.../imaging/formats/jpeg/xmp/JpegXmpParser.java | 2 +-
.../imaging/formats/pcx/PcxImagingParameters.java | 6 +-
.../imaging/formats/png/GammaCorrection.java | 4 +-
.../commons/imaging/formats/png/PhysicalScale.java | 8 +--
.../commons/imaging/formats/png/PngColorType.java | 2 +-
.../imaging/formats/png/PngImageParser.java | 2 +-
.../imaging/formats/png/PngImagingParameters.java | 6 +-
.../formats/png/chunks/AbstractPngTextChunk.java | 6 +-
.../imaging/formats/png/chunks/PngChunk.java | 10 +--
.../imaging/formats/png/chunks/PngChunkGama.java | 2 +-
.../imaging/formats/png/chunks/PngChunkIccp.java | 8 +--
.../imaging/formats/png/chunks/PngChunkIhdr.java | 14 ++--
.../imaging/formats/png/chunks/PngChunkItxt.java | 2 +-
.../imaging/formats/png/chunks/PngChunkPhys.java | 2 +-
.../imaging/formats/png/chunks/PngChunkPlte.java | 4 +-
.../imaging/formats/png/chunks/PngChunkScal.java | 2 +-
.../imaging/formats/png/chunks/PngChunkText.java | 4 +-
.../imaging/formats/png/chunks/PngChunkZtxt.java | 4 +-
.../AbstractTransparencyFilter.java | 4 +-
.../imaging/formats/pnm/PnmImagingParameters.java | 2 +-
.../commons/imaging/formats/psd/PsdHeaderInfo.java | 2 +-
.../psd/dataparsers/AbstractDataParser.java | 4 +-
.../imaging/formats/tiff/AbstractTiffElement.java | 6 +-
.../formats/tiff/AbstractTiffImageData.java | 8 +--
.../formats/tiff/AbstractTiffRasterData.java | 18 ++---
.../commons/imaging/formats/tiff/TiffContents.java | 4 +-
.../imaging/formats/tiff/TiffDirectory.java | 78 +++++++++++-----------
.../commons/imaging/formats/tiff/TiffField.java | 44 ++++++------
.../imaging/formats/tiff/TiffImageMetadata.java | 60 ++++++++---------
.../imaging/formats/tiff/TiffImageParser.java | 4 +-
.../formats/tiff/TiffImagingParameters.java | 10 +--
.../imaging/formats/tiff/TiffRasterDataFloat.java | 10 +--
.../imaging/formats/tiff/TiffRasterDataInt.java | 10 +--
.../imaging/formats/tiff/TiffRasterStatistics.java | 12 ++--
.../commons/imaging/formats/tiff/TiffReader.java | 6 +-
.../formats/tiff/constants/TiffDirectoryType.java | 2 +-
.../tiff/datareaders/AbstractImageDataReader.java | 4 +-
.../formats/tiff/fieldtypes/AbstractFieldType.java | 10 +--
.../formats/tiff/itu_t4/T4AndT6Compression.java | 16 ++---
.../AbstractPhotometricInterpreter.java | 2 +-
.../PhotometricInterpreterYCbCr.java | 2 +-
.../imaging/formats/tiff/taginfos/TagInfo.java | 6 +-
.../formats/tiff/taginfos/TagInfoAscii.java | 4 +-
.../imaging/formats/tiff/taginfos/TagInfoByte.java | 2 +-
.../formats/tiff/taginfos/TagInfoByteOrShort.java | 4 +-
.../formats/tiff/taginfos/TagInfoBytes.java | 2 +-
.../formats/tiff/taginfos/TagInfoDouble.java | 4 +-
.../formats/tiff/taginfos/TagInfoDoubles.java | 4 +-
.../formats/tiff/taginfos/TagInfoFloat.java | 4 +-
.../formats/tiff/taginfos/TagInfoFloats.java | 4 +-
.../imaging/formats/tiff/taginfos/TagInfoLong.java | 4 +-
.../formats/tiff/taginfos/TagInfoLongOrIfd.java | 4 +-
.../formats/tiff/taginfos/TagInfoLongs.java | 4 +-
.../formats/tiff/taginfos/TagInfoRational.java | 4 +-
.../formats/tiff/taginfos/TagInfoRationals.java | 4 +-
.../formats/tiff/taginfos/TagInfoSByte.java | 2 +-
.../formats/tiff/taginfos/TagInfoSBytes.java | 2 +-
.../formats/tiff/taginfos/TagInfoSLong.java | 4 +-
.../formats/tiff/taginfos/TagInfoSLongs.java | 4 +-
.../formats/tiff/taginfos/TagInfoSRational.java | 4 +-
.../formats/tiff/taginfos/TagInfoSRationals.java | 4 +-
.../formats/tiff/taginfos/TagInfoSShort.java | 4 +-
.../formats/tiff/taginfos/TagInfoSShorts.java | 4 +-
.../formats/tiff/taginfos/TagInfoShort.java | 4 +-
.../formats/tiff/taginfos/TagInfoShortOrLong.java | 4 +-
.../taginfos/TagInfoShortOrLongOrRational.java | 6 +-
.../tiff/taginfos/TagInfoShortOrRational.java | 4 +-
.../formats/tiff/taginfos/TagInfoShorts.java | 4 +-
.../tiff/write/AbstractTiffImageWriter.java | 2 +-
.../formats/tiff/write/AbstractTiffOutputItem.java | 6 +-
.../formats/tiff/write/TiffOutputDirectory.java | 14 ++--
.../formats/tiff/write/TiffOutputField.java | 8 +--
.../imaging/formats/tiff/write/TiffOutputSet.java | 32 ++++-----
.../formats/webp/chunks/AbstractWebPChunk.java | 8 +--
.../imaging/formats/webp/chunks/WebPChunkVp8.java | 10 +--
.../imaging/formats/webp/chunks/WebPChunkVp8l.java | 6 +-
.../imaging/formats/webp/chunks/WebPChunkVp8x.java | 4 +-
.../imaging/formats/webp/chunks/WebPChunkXml.java | 2 +-
.../apache/commons/imaging/icc/IccProfileInfo.java | 2 +-
.../commons/imaging/icc/IccProfileParser.java | 8 +--
.../imaging/internal/ImageParserFactory.java | 6 +-
.../commons/imaging/internal/SafeOperations.java | 2 +-
.../imaging/mylzw/BitsToByteInputStream.java | 4 +-
.../commons/imaging/mylzw/MyBitInputStream.java | 2 +-
.../commons/imaging/mylzw/MyLzwCompressor.java | 2 +-
.../imaging/palette/MedianCutQuantizer.java | 2 +-
.../apache/commons/imaging/palette/Palette.java | 6 +-
.../commons/imaging/palette/PaletteFactory.java | 8 +--
.../imaging/examples/tiff/SurveyTiffFile.java | 2 +-
.../formats/tiff/TiffReadImageInfoTest.java | 2 +-
133 files changed, 525 insertions(+), 525 deletions(-)
diff --git a/src/main/java/org/apache/commons/imaging/ColorTools.java b/src/main/java/org/apache/commons/imaging/ColorTools.java
index b3944b95..9a34cd7a 100644
--- a/src/main/java/org/apache/commons/imaging/ColorTools.java
+++ b/src/main/java/org/apache/commons/imaging/ColorTools.java
@@ -54,7 +54,7 @@ public class ColorTools {
* @param bi the source image.
* @param from the source color space.
* @param to the target color space.
- * @return the converted image.
+ * @return The converted image.
*/
public BufferedImage convertBetweenColorSpaces(BufferedImage bi, final ColorSpace from, final ColorSpace to) {
final RenderingHints hints = new RenderingHints(RenderingHints.KEY_RENDERING, RenderingHints.VALUE_RENDER_QUALITY);
@@ -76,7 +76,7 @@ public class ColorTools {
* @param bi the source image.
* @param from the source color space.
* @param to the target color space.
- * @return the converted image.
+ * @return The converted image.
*/
public BufferedImage convertBetweenColorSpacesX2(BufferedImage bi, final ColorSpace from, final ColorSpace to) {
final RenderingHints hints = new RenderingHints(RenderingHints.KEY_RENDERING, RenderingHints.VALUE_RENDER_QUALITY);
@@ -106,7 +106,7 @@ public class ColorTools {
* @param bi the source image.
* @param from the source ICC profile.
* @param to the target ICC profile.
- * @return the converted image.
+ * @return The converted image.
*/
public BufferedImage convertBetweenIccProfiles(final BufferedImage bi, final ICC_Profile from, final ICC_Profile to) {
final ICC_ColorSpace csFrom = new ICC_ColorSpace(from);
@@ -120,7 +120,7 @@ public class ColorTools {
*
* @param bi the source image.
* @param from the source color space.
- * @return the converted image.
+ * @return The converted image.
*/
protected BufferedImage convertFromColorSpace(final BufferedImage bi, final ColorSpace from) {
final ColorModel srgbCM = ColorModel.getRGBdefault();
@@ -132,7 +132,7 @@ public class ColorTools {
*
* @param bi the source image.
* @param to the target color space.
- * @return the converted image.
+ * @return The converted image.
*/
public BufferedImage convertToColorSpace(final BufferedImage bi, final ColorSpace to) {
final ColorSpace from = bi.getColorModel().getColorSpace();
@@ -153,7 +153,7 @@ public class ColorTools {
*
* @param bi the source image.
* @param to the target ICC profile.
- * @return the converted image.
+ * @return The converted image.
*/
public BufferedImage convertToIccProfile(final BufferedImage bi, final ICC_Profile to) {
final ICC_ColorSpace csTo = new ICC_ColorSpace(to);
@@ -164,7 +164,7 @@ public class ColorTools {
* Converts an image to sRGB color space.
*
* @param bi the source image.
- * @return the converted image.
+ * @return The converted image.
*/
public BufferedImage convertTosRgb(final BufferedImage bi) {
final ColorModel srgbCM = ColorModel.getRGBdefault();
@@ -176,7 +176,7 @@ public class ColorTools {
*
* @param src the source image.
* @param file the file containing the ICC profile.
- * @return the corrected image.
+ * @return The corrected image.
* @throws ImagingException if the image format is invalid.
* @throws IOException if an I/O error occurs.
*/
@@ -207,7 +207,7 @@ public class ColorTools {
*
* @param bi the source image.
* @param cs the target color space.
- * @return the derived color model.
+ * @return The derived color model.
* @throws ImagingOpException if the color model cannot be derived.
*/
public ColorModel deriveColorModel(final BufferedImage bi, final ColorSpace cs) throws ImagingOpException {
@@ -221,7 +221,7 @@ public class ColorTools {
* @param bi the source image.
* @param cs the target color space.
* @param forceNoAlpha whether to force no alpha channel.
- * @return the derived color model.
+ * @return The derived color model.
* @throws ImagingOpException if the color model cannot be derived.
*/
public ColorModel deriveColorModel(final BufferedImage bi, final ColorSpace cs, final boolean forceNoAlpha) throws ImagingOpException {
@@ -234,7 +234,7 @@ public class ColorTools {
* @param colorModel the source color model.
* @param cs the target color space.
* @param forceNoAlpha whether to force no alpha channel.
- * @return the derived color model.
+ * @return The derived color model.
* @throws ImagingOpException if the color model cannot be derived.
*/
public ColorModel deriveColorModel(final ColorModel colorModel, final ColorSpace cs, final boolean forceNoAlpha) throws ImagingOpException {
@@ -286,7 +286,7 @@ public class ColorTools {
*
* @param bi the source image.
* @param cm the new color model.
- * @return the relabeled image.
+ * @return The relabeled image.
* @throws ImagingOpException if the relabeling fails.
*/
public BufferedImage relabelColorSpace(final BufferedImage bi, final ColorModel cm) throws ImagingOpException {
@@ -304,7 +304,7 @@ public class ColorTools {
*
* @param bi the source image.
* @param cs the new color space.
- * @return the relabeled image.
+ * @return The relabeled image.
* @throws ImagingOpException if the relabeling fails.
*/
public BufferedImage relabelColorSpace(final BufferedImage bi, final ColorSpace cs) throws ImagingOpException {
@@ -325,7 +325,7 @@ public class ColorTools {
*
* @param bi the source image.
* @param profile the new ICC profile.
- * @return the relabeled image.
+ * @return The relabeled image.
* @throws ImagingOpException if the relabeling fails.
*/
public BufferedImage relabelColorSpace(final BufferedImage bi, final ICC_Profile profile) throws ImagingOpException {
diff --git a/src/main/java/org/apache/commons/imaging/ImageFormat.java b/src/main/java/org/apache/commons/imaging/ImageFormat.java
index 508d5966..db2a8111 100644
--- a/src/main/java/org/apache/commons/imaging/ImageFormat.java
+++ b/src/main/java/org/apache/commons/imaging/ImageFormat.java
@@ -24,7 +24,7 @@ public interface ImageFormat {
/**
* Gets the default file extension.
*
- * @return the default file extension.
+ * @return The default file extension.
*/
String getDefaultExtension();
diff --git a/src/main/java/org/apache/commons/imaging/ImageInfo.java b/src/main/java/org/apache/commons/imaging/ImageInfo.java
index 4de1c3c7..fc05077a 100644
--- a/src/main/java/org/apache/commons/imaging/ImageInfo.java
+++ b/src/main/java/org/apache/commons/imaging/ImageInfo.java
@@ -278,7 +278,7 @@ public class ImageInfo {
/**
* Returns a string with the name of the image file format.
*
- * @return the name of the image file format.
+ * @return The name of the image file format.
* @see #getFormat()
*/
public String getFormatName() {
diff --git a/src/main/java/org/apache/commons/imaging/Imaging.java b/src/main/java/org/apache/commons/imaging/Imaging.java
index 5fb0a5ab..a7ca4a77 100644
--- a/src/main/java/org/apache/commons/imaging/Imaging.java
+++ b/src/main/java/org/apache/commons/imaging/Imaging.java
@@ -314,7 +314,7 @@ public final class Imaging {
* Gets the ICC profile from a byte source.
*
* @param byteSource the byte source.
- * @return the ICC profile, or null if not found.
+ * @return The ICC profile, or null if not found.
* @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/ImagingParameters.java b/src/main/java/org/apache/commons/imaging/ImagingParameters.java
index cd96c144..c788209c 100644
--- a/src/main/java/org/apache/commons/imaging/ImagingParameters.java
+++ b/src/main/java/org/apache/commons/imaging/ImagingParameters.java
@@ -78,7 +78,7 @@ public class ImagingParameters<E extends ImagingParameters<E>> {
/**
* Gets the buffered image factory.
*
- * @return the buffered image factory, or null if not set.
+ * @return The buffered image factory, or null if not set.
*/
public BufferedImageFactory getBufferedImageFactory() {
return bufferedImageFactory;
@@ -87,7 +87,7 @@ public class ImagingParameters<E extends ImagingParameters<E>> {
/**
* Gets the file name.
*
- * @return the file name, or null if not set.
+ * @return The file name, or null if not set.
*/
public String getFileName() {
return fileName;
@@ -96,7 +96,7 @@ public class ImagingParameters<E extends ImagingParameters<E>> {
/**
* Gets the pixel density.
*
- * @return the pixel density, or null if not set.
+ * @return The pixel density, or null if not set.
*/
public PixelDensity getPixelDensity() {
return pixelDensity;
diff --git a/src/main/java/org/apache/commons/imaging/PixelDensity.java b/src/main/java/org/apache/commons/imaging/PixelDensity.java
index 7525630b..45677ad4 100644
--- a/src/main/java/org/apache/commons/imaging/PixelDensity.java
+++ b/src/main/java/org/apache/commons/imaging/PixelDensity.java
@@ -30,7 +30,7 @@ public final class PixelDensity {
*
* @param x horizontal density in pixels per centimetre.
* @param y vertical density in pixels per centimetre.
- * @return the pixel density.
+ * @return The pixel density.
*/
public static PixelDensity createFromPixelsPerCentimetre(final double x, final double y) {
return new PixelDensity(x, y, PIXEL_PER_CENTIMETRE);
@@ -41,7 +41,7 @@ public final class PixelDensity {
*
* @param x horizontal density in pixels per inch.
* @param y vertical density in pixels per inch.
- * @return the pixel density.
+ * @return The pixel density.
*/
public static PixelDensity createFromPixelsPerInch(final double x, final double y) {
return new PixelDensity(x, y, PIXEL_PER_INCH);
@@ -52,7 +52,7 @@ public final class PixelDensity {
*
* @param x horizontal density in pixels per metre.
* @param y vertical density in pixels per metre.
- * @return the pixel density.
+ * @return The pixel density.
*/
public static PixelDensity createFromPixelsPerMetre(final double x, final double y) {
return new PixelDensity(x, y, PIXEL_PER_METRE);
@@ -63,7 +63,7 @@ public final class PixelDensity {
*
* @param x horizontal density (unitless).
* @param y vertical density (unitless).
- * @return the pixel density.
+ * @return The pixel density.
*/
public static PixelDensity createUnitless(final double x, final double y) {
return new PixelDensity(x, y, PIXEL_NO_UNIT);
@@ -85,7 +85,7 @@ public final class PixelDensity {
/**
* Gets the raw horizontal density.
*
- * @return the raw horizontal density.
+ * @return The raw horizontal density.
*/
public double getRawHorizontalDensity() {
return horizontalDensity;
@@ -94,7 +94,7 @@ public final class PixelDensity {
/**
* Gets the raw vertical density.
*
- * @return the raw vertical density.
+ * @return The raw vertical density.
*/
public double getRawVerticalDensity() {
return verticalDensity;
@@ -103,7 +103,7 @@ public final class PixelDensity {
/**
* Gets the horizontal density in pixels per centimetre.
*
- * @return the horizontal density in pixels per centimetre.
+ * @return The horizontal density in pixels per centimetre.
*/
public double horizontalDensityCentimetres() {
if (isInCentimetres()) {
@@ -115,7 +115,7 @@ public final class PixelDensity {
/**
* Gets the horizontal density in pixels per inch.
*
- * @return the horizontal density in pixels per inch.
+ * @return The horizontal density in pixels per inch.
*/
public double horizontalDensityInches() {
if (isInInches()) {
@@ -127,7 +127,7 @@ public final class PixelDensity {
/**
* Gets the horizontal density in pixels per metre.
*
- * @return the horizontal density in pixels per metre.
+ * @return The horizontal density in pixels per metre.
*/
public double horizontalDensityMetres() {
if (isInMetres()) {
@@ -175,7 +175,7 @@ public final class PixelDensity {
/**
* Gets the vertical density in pixels per centimetre.
*
- * @return the vertical density in pixels per centimetre.
+ * @return The vertical density in pixels per centimetre.
*/
public double verticalDensityCentimetres() {
if (isInCentimetres()) {
@@ -187,7 +187,7 @@ public final class PixelDensity {
/**
* Gets the vertical density in pixels per inch.
*
- * @return the vertical density in pixels per inch.
+ * @return The vertical density in pixels per inch.
*/
public double verticalDensityInches() {
if (isInInches()) {
@@ -199,7 +199,7 @@ public final class PixelDensity {
/**
* Gets the vertical density in pixels per metre.
*
- * @return the vertical density in pixels per metre.
+ * @return The vertical density in pixels per metre.
*/
public double verticalDensityMetres() {
if (isInMetres()) {
diff --git a/src/main/java/org/apache/commons/imaging/bytesource/ByteSource.java b/src/main/java/org/apache/commons/imaging/bytesource/ByteSource.java
index 32fc6c7e..0fe36f30 100644
--- a/src/main/java/org/apache/commons/imaging/bytesource/ByteSource.java
+++ b/src/main/java/org/apache/commons/imaging/bytesource/ByteSource.java
@@ -38,7 +38,7 @@ public class ByteSource {
* Creates a ByteSource from a byte array.
*
* @param array the byte array.
- * @return the ByteSource.
+ * @return The ByteSource.
*/
public static ByteSource array(final byte[] array) {
return new ByteSource(new ByteArrayOrigin(array), null);
@@ -49,7 +49,7 @@ public class ByteSource {
*
* @param array the byte array.
* @param name the name.
- * @return the ByteSource.
+ * @return The ByteSource.
*/
public static ByteSource array(final byte[] array, final String name) {
return new ByteSource(new ByteArrayOrigin(array), name);
@@ -59,7 +59,7 @@ public class ByteSource {
* Creates a ByteSource from a file.
*
* @param file the file.
- * @return the ByteSource.
+ * @return The ByteSource.
*/
public static ByteSource file(final File file) {
return new ByteSource(new FileOrigin(file), file.getName());
@@ -70,7 +70,7 @@ public class ByteSource {
*
* @param byteSource the byte source.
* @param skip the number of bytes to skip.
- * @return the input stream.
+ * @return The input stream.
* @throws IOException if an I/O error occurs.
*/
public static final InputStream getInputStream(final ByteSource byteSource, final long skip) throws IOException {
@@ -93,7 +93,7 @@ public class ByteSource {
*
* @param is the input stream.
* @param name the name.
- * @return the ByteSource.
+ * @return The ByteSource.
* @throws IOException if an I/O error occurs.
*/
public static ByteSource inputStream(final InputStream is, final String name) throws IOException {
@@ -104,7 +104,7 @@ public class ByteSource {
* Creates a ByteSource from a path.
*
* @param file the path.
- * @return the ByteSource.
+ * @return The ByteSource.
*/
public static ByteSource path(final Path file) {
return new ByteSource(new PathOrigin(file), Objects.toString(file.getFileName(), null));
@@ -129,7 +129,7 @@ public class ByteSource {
*
* @param position the position.
* @param length the length.
- * @return the byte array.
+ * @return The byte array.
* @throws IOException if an I/O error occurs.
*/
public byte[] getByteArray(final long position, final int length) throws IOException {
@@ -139,7 +139,7 @@ public class ByteSource {
/**
* Gets the file name.
*
- * @return the file name.
+ * @return The file name.
*/
public final String getFileName() {
return fileName;
@@ -148,7 +148,7 @@ public class ByteSource {
/**
* Gets an input stream.
*
- * @return the input stream.
+ * @return The input stream.
* @throws IOException if an I/O error occurs.
*/
public InputStream getInputStream() throws IOException {
@@ -158,7 +158,7 @@ public class ByteSource {
/**
* This operation can be VERY expensive; for InputStream byte sources, the entire stream must be drained to determine its length.
*
- * @return the length.
+ * @return The length.
* @throws IOException if an I/O error occurs.
*/
public long size() throws IOException {
diff --git a/src/main/java/org/apache/commons/imaging/color/ColorConversions.java b/src/main/java/org/apache/commons/imaging/color/ColorConversions.java
index dfe96df2..a4f055f2 100644
--- a/src/main/java/org/apache/commons/imaging/color/ColorConversions.java
+++ b/src/main/java/org/apache/commons/imaging/color/ColorConversions.java
@@ -43,7 +43,7 @@ public final class ColorConversions {
* @param cieL the L* value.
* @param cieA the a* value.
* @param cieB the b* value.
- * @return the ARGB color value.
+ * @return The ARGB color value.
*/
public static int convertCieLabToArgbTest(final int cieL, final int cieA, final int cieB) {
final double x;
@@ -93,7 +93,7 @@ public final class ColorConversions {
* Converts CIE L*a*b* to CIE LCH.
*
* @param cielab the CIE L*a*b* color.
- * @return the CIE LCH color.
+ * @return The CIE LCH color.
*/
public static ColorCieLch convertCieLabToCieLch(final ColorCieLab cielab) {
return convertCieLabToCieLch(cielab.l, cielab.a, cielab.b);
@@ -105,7 +105,7 @@ public final class ColorConversions {
* @param l the L* value.
* @param a the a* value.
* @param b the b* value.
- * @return the CIE LCH color.
+ * @return The CIE LCH color.
*/
public static ColorCieLch convertCieLabToCieLch(final double l, final double a, final double b) {
// atan2(y, x) returns atan(y/x)
@@ -125,7 +125,7 @@ public final class ColorConversions {
* Converts CIE L*a*b* to DIN99b Lab.
*
* @param cie the CIE L*a*b* color.
- * @return the DIN99b Lab color.
+ * @return The DIN99b Lab color.
*/
public static ColorDin99Lab convertCieLabToDin99bLab(final ColorCieLab cie) {
return convertCieLabToDin99bLab(cie.l, cie.a, cie.b);
@@ -137,7 +137,7 @@ public final class ColorConversions {
* @param l the L* value.
* @param a the a* value.
* @param b the b* value.
- * @return the DIN99b Lab color.
+ * @return The DIN99b Lab color.
*/
public static ColorDin99Lab convertCieLabToDin99bLab(final double l, final double a, final double b) {
final double fac1 = 100.0 / Math.log(129.0 / 50.0); // = 105.51
@@ -209,7 +209,7 @@ public final class ColorConversions {
* Converts CIE L*a*b* to CIE XYZ.
*
* @param cielab the CIE L*a*b* color.
- * @return the CIE XYZ color.
+ * @return The CIE XYZ color.
*/
public static ColorXyz convertCieLabToXyz(final ColorCieLab cielab) {
return convertCieLabToXyz(cielab.l, cielab.a, cielab.b);
@@ -221,7 +221,7 @@ public final class ColorConversions {
* @param l the L* value.
* @param a the a* value.
* @param b the b* value.
- * @return the CIE XYZ color.
+ * @return The CIE XYZ color.
*/
public static ColorXyz convertCieLabToXyz(final double l, final double a, final double b) {
double varY = (l + 16) / 116.0;
@@ -244,7 +244,7 @@ public final class ColorConversions {
* Converts CIE LCH to CIE L*a*b*.
*
* @param cielch the CIE LCH color.
- * @return the CIE L*a*b* color.
+ * @return The CIE L*a*b* color.
*/
public static ColorCieLab convertCieLchToCieLab(final ColorCieLch cielch) {
return convertCieLchToCieLab(cielch.l, cielch.c, cielch.h);
@@ -256,7 +256,7 @@ public final class ColorConversions {
* @param l the L* value.
* @param c the C* value.
* @param h the h° value.
- * @return the CIE L*a*b* color.
+ * @return The CIE L*a*b* color.
*/
public static ColorCieLab convertCieLchToCieLab(final double l, final double c, final double h) {
// Where CIE-H° = 0 ÷ 360°
@@ -272,7 +272,7 @@ public final class ColorConversions {
* Converts CIE Luv to CIE XYZ.
*
* @param cielch the CIE Luv color.
- * @return the CIE XYZ color.
+ * @return The CIE XYZ color.
*/
public static ColorXyz convertCieLuvToXyz(final ColorCieLuv cielch) {
return convertCieLuvToXyz(cielch.l, cielch.u, cielch.v);
@@ -284,7 +284,7 @@ public final class ColorConversions {
* @param l the L* value.
* @param u the u* value.
* @param v the v* value.
- * @return the CIE XYZ color.
+ * @return The CIE XYZ color.
*/
public static ColorXyz convertCieLuvToXyz(final double l, final double u, final double v) {
// problems here with div by zero
@@ -307,7 +307,7 @@ public final class ColorConversions {
* Converts CMYK to CMY.
*
* @param cmyk the CMYK color.
- * @return the CMY color.
+ * @return The CMY color.
*/
public static ColorCmy convertCmykToCmy(final ColorCmyk cmyk) {
return convertCmykToCmy(cmyk.c, cmyk.m, cmyk.y, cmyk.k);
@@ -320,7 +320,7 @@ public final class ColorConversions {
* @param m the magenta value.
* @param y the yellow value.
* @param k the black value.
- * @return the CMY color.
+ * @return The CMY color.
*/
public static ColorCmy convertCmykToCmy(double c, double m, double y, final double k) {
// Where CMYK and CMY values = 0 ÷ 1
@@ -339,7 +339,7 @@ public final class ColorConversions {
* @param m the magenta value.
* @param y the yellow value.
* @param k the black value.
- * @return the RGB color as int.
+ * @return The RGB color as int.
*/
public static int convertCmykToRgb(final int c, final int m, final int y, final int k) {
final double C = c / 255.0;
@@ -357,7 +357,7 @@ public final class ColorConversions {
* @param sm the magenta value.
* @param sy the yellow value.
* @param sk the black value.
- * @return the RGB color as int.
+ * @return The RGB color as int.
*/
public static int convertCmykToRgbAdobe(final int sc, final int sm, final int sy, final int sk) {
final int red = 255 - (sc + sk);
@@ -371,7 +371,7 @@ public final class ColorConversions {
* Converts CMY to CMYK.
*
* @param cmy the CMY color.
- * @return the CMYK color.
+ * @return The CMYK color.
*/
public static ColorCmyk convertCmyToCmyk(final ColorCmy cmy) {
// Where CMYK and CMY values = 0 ÷ 1
@@ -407,7 +407,7 @@ public final class ColorConversions {
* Converts CMY to RGB.
*
* @param cmy the CMY color.
- * @return the RGB color as int.
+ * @return The RGB color as int.
*/
public static int convertCmyToRgb(final ColorCmy cmy) {
// From Ghostscript's gdevcdj.c:
@@ -430,7 +430,7 @@ public final class ColorConversions {
* Converts DIN99b Lab to CIE L*a*b*.
*
* @param dinb the DIN99b Lab color.
- * @return the CIE L*a*b* color.
+ * @return The CIE L*a*b* color.
*/
public static ColorCieLab convertDin99bLabToCieLab(final ColorDin99Lab dinb) {
return convertDin99bLabToCieLab(dinb.l99, dinb.a99, dinb.b99);
@@ -442,7 +442,7 @@ public final class ColorConversions {
* @param L99b the L99 value.
* @param a99b the a99 value.
* @param b99b the b99 value.
- * @return the CIE L*a*b* color.
+ * @return The CIE L*a*b* color.
*/
public static ColorCieLab convertDin99bLabToCieLab(final double L99b, final double a99b, final double b99b) {
final double kE = 1.0; // brightness factor, 1.0 for CIE reference conditions
@@ -511,7 +511,7 @@ public final class ColorConversions {
* Converts HSL to RGB.
*
* @param hsl the HSL color.
- * @return the RGB color as int.
+ * @return The RGB color as int.
*/
public static int convertHslToRgb(final ColorHsl hsl) {
return convertHslToRgb(hsl.h, hsl.s, hsl.l);
@@ -523,7 +523,7 @@ public final class ColorConversions {
* @param h the hue value.
* @param s the saturation value.
* @param l the lightness value.
- * @return the RGB color as int.
+ * @return The RGB color as int.
*/
public static int convertHslToRgb(final double h, final double s, final double l) {
final double r;
@@ -557,7 +557,7 @@ public final class ColorConversions {
* Converts HSV to RGB.
*
* @param HSV the HSV color.
- * @return the RGB color as int.
+ * @return The RGB color as int.
*/
public static int convertHsvToRgb(final ColorHsv HSV) {
return convertHsvToRgb(HSV.h, HSV.s, HSV.v);
@@ -569,7 +569,7 @@ public final class ColorConversions {
* @param h the hue value.
* @param s the saturation value.
* @param v the value (brightness) value.
- * @return the RGB color as int.
+ * @return The RGB color as int.
*/
public static int convertHsvToRgb(final double h, final double s, final double v) {
final double r;
@@ -651,7 +651,7 @@ public final class ColorConversions {
* Converts Hunter Lab to CIE XYZ.
*
* @param cielab the Hunter Lab color.
- * @return the CIE XYZ color.
+ * @return The CIE XYZ color.
*/
public static ColorXyz convertHunterLabToXyz(final ColorHunterLab cielab) {
return convertHunterLabToXyz(cielab.l, cielab.a, cielab.b);
@@ -663,7 +663,7 @@ public final class ColorConversions {
* @param l the L value.
* @param a the a value.
* @param b the b value.
- * @return the CIE XYZ color.
+ * @return The CIE XYZ color.
*/
public static ColorXyz convertHunterLabToXyz(final double l, final double a, final double b) {
final double varY = l / 10;
@@ -681,7 +681,7 @@ public final class ColorConversions {
* Converts RGB to CMY.
*
* @param rgb the RGB color as int.
- * @return the CMY color.
+ * @return The CMY color.
*/
public static ColorCmy convertRgbToCmy(final int rgb) {
final int r = 0xff & rgb >> 16;
@@ -702,7 +702,7 @@ public final class ColorConversions {
* Converts RGB to HSL.
*
* @param rgb the RGB color as int.
- * @return the HSL color.
+ * @return The HSL color.
*/
public static ColorHsl convertRgbToHsl(final int rgb) {
@@ -784,7 +784,7 @@ public final class ColorConversions {
* Converts RGB to HSV.
*
* @param rgb the RGB color as int.
- * @return the HSV color.
+ * @return The HSV color.
*/
public static ColorHsv convertRgbToHsv(final int rgb) {
final int r = 0xff & rgb >> 16;
@@ -874,7 +874,7 @@ public final class ColorConversions {
* Converts RGB to CIE XYZ.
*
* @param rgb the RGB color as int.
- * @return the CIE XYZ color.
+ * @return The CIE XYZ color.
*/
public static ColorXyz convertRgbToXyz(final int rgb) {
final int r = 0xff & rgb >> 16;
@@ -914,7 +914,7 @@ public final class ColorConversions {
* @param x the X value.
* @param y the Y value.
* @param z the Z value.
- * @return the CIE Luv color.
+ * @return The CIE Luv color.
*/
public static ColorCieLuv convertXuzToCieLuv(final double x, final double y, final double z) {
// problems here with div by zero
@@ -949,7 +949,7 @@ public final class ColorConversions {
* Converts CIE XYZ to CIE L*a*b*.
*
* @param xyz the CIE XYZ color.
- * @return the CIE L*a*b* color.
+ * @return The CIE L*a*b* color.
*/
public static ColorCieLab convertXyzToCieLab(final ColorXyz xyz) {
return convertXyzToCieLab(xyz.x, xyz.y, xyz.z);
@@ -961,7 +961,7 @@ public final class ColorConversions {
* @param x the X value.
* @param y the Y value.
* @param z the Z value.
- * @return the CIE L*a*b* color.
+ * @return The CIE L*a*b* color.
*/
public static ColorCieLab convertXyzToCieLab(final double x, final double y, final double z) {
@@ -985,7 +985,7 @@ public final class ColorConversions {
* Converts CIE XYZ to CIE Luv.
*
* @param xyz the CIE XYZ color.
- * @return the CIE Luv color.
+ * @return The CIE Luv color.
*/
public static ColorCieLuv convertXyzToCieLuv(final ColorXyz xyz) {
return convertXuzToCieLuv(xyz.x, xyz.y, xyz.z);
@@ -995,7 +995,7 @@ public final class ColorConversions {
* Converts CIE XYZ to Hunter Lab.
*
* @param xyz the CIE XYZ color.
- * @return the Hunter Lab color.
+ * @return The Hunter Lab color.
*/
public static ColorHunterLab convertXyzToHunterLab(final ColorXyz xyz) {
return convertXyzToHunterLab(xyz.x, xyz.y, xyz.z);
@@ -1007,7 +1007,7 @@ public final class ColorConversions {
* @param x the X value.
* @param y the Y value.
* @param z the Z value.
- * @return the Hunter Lab color.
+ * @return The Hunter Lab color.
*/
public static ColorHunterLab convertXyzToHunterLab(final double x, final double y, final double z) {
final double l = 10 * Math.sqrt(y);
@@ -1021,7 +1021,7 @@ public final class ColorConversions {
* Converts CIE XYZ to RGB.
*
* @param xyz the CIE XYZ color.
- * @return the RGB color as int.
+ * @return The RGB color as int.
*/
public static int convertXyzToRgb(final ColorXyz xyz) {
return convertXyzToRgb(xyz.x, xyz.y, xyz.z);
@@ -1033,7 +1033,7 @@ public final class ColorConversions {
* @param x the X value.
* @param y the Y value.
* @param z the Z value.
- * @return the RGB color as int.
+ * @return The RGB color as int.
*/
public static int convertXyzToRgb(final double x, final double y, final double z) {
// Observer = 2°, Illuminant = D65
@@ -1065,7 +1065,7 @@ public final class ColorConversions {
* Converts degrees to radians.
*
* @param degree the angle in degrees.
- * @return the angle in radians.
+ * @return The angle in radians.
*/
public static double degree2radian(final double degree) {
return degree * Math.PI / 180.0;
@@ -1093,7 +1093,7 @@ public final class ColorConversions {
* Converts radians to degrees.
*
* @param radian the angle in radians.
- * @return the angle in degrees.
+ * @return The angle in degrees.
*/
public static double radian2degree(final double radian) {
return radian * 180.0 / Math.PI;
diff --git a/src/main/java/org/apache/commons/imaging/common/AllocationRequestException.java b/src/main/java/org/apache/commons/imaging/common/AllocationRequestException.java
index a824e454..0cc66673 100644
--- a/src/main/java/org/apache/commons/imaging/common/AllocationRequestException.java
+++ b/src/main/java/org/apache/commons/imaging/common/AllocationRequestException.java
@@ -89,7 +89,7 @@ public class AllocationRequestException extends ImagingRuntimeException {
/**
* Gets the allocation limit.
*
- * @return the allocation limit.
+ * @return The allocation limit.
*/
public int getLimit() {
return limit;
@@ -98,7 +98,7 @@ public class AllocationRequestException extends ImagingRuntimeException {
/**
* Gets the allocation request.
*
- * @return the allocation request.
+ * @return The allocation request.
*/
public BigInteger getRequest() {
return request;
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 097a8436..75f48ef0 100644
--- a/src/main/java/org/apache/commons/imaging/common/Allocator.java
+++ b/src/main/java/org/apache/commons/imaging/common/Allocator.java
@@ -123,7 +123,7 @@ public final class Allocator {
* </p>
*
* @param request an allocation request.
- * @return the request.
+ * @return The request.
* @throws AllocationRequestException Thrown when the request exceeds the limit.
*/
public static int check(final int request) {
@@ -141,7 +141,7 @@ public final class Allocator {
*
* @param request an allocation request count.
* @param elementSize The element size.
- * @return the request.
+ * @return The request.
* @throws AllocationRequestException Thrown when the request exceeds the limit.
*/
public static int check(final int request, final int elementSize) {
@@ -165,7 +165,7 @@ public final class Allocator {
*
* @param request an allocation request count is cast down to an int.
* @param elementSize The element size.
- * @return the request.
+ * @return The request.
* @throws AllocationRequestException Thrown when the request exceeds the limit.
*/
public static int check(final long request, final int elementSize) {
diff --git a/src/main/java/org/apache/commons/imaging/common/BasicCParser.java b/src/main/java/org/apache/commons/imaging/common/BasicCParser.java
index d852c800..f290aa91 100644
--- a/src/main/java/org/apache/commons/imaging/common/BasicCParser.java
+++ b/src/main/java/org/apache/commons/imaging/common/BasicCParser.java
@@ -43,7 +43,7 @@ public class BasicCParser {
* @param i the index of the escape-sequence in the string
* @param stringBuilder the stringBuilder to append the escape-char to
* @param string the string whose chars are parsed
- * @return the new index i
+ * @return The new index i
* @since 1.0-alpha3
*/
private static int appendHex(int i, final StringBuilder stringBuilder, final String string) throws ImagingException {
@@ -73,7 +73,7 @@ public class BasicCParser {
* @param i the index of the escape-sequence in the string
* @param stringBuilder the stringBuilder to append the escape-char to
* @param string the string whose chars are parsed
- * @return the new index i
+ * @return The new index i
* @since 1.0-alpha3
*/
private static int appendOct(int i, final StringBuilder stringBuilder, final String string) {
@@ -104,7 +104,7 @@ public class BasicCParser {
* @param i the index of the escape-char in the string
* @param stringBuilder the stringBuilder to append the escape-char to
* @param string the string whose chars are parsed
- * @return the new index i
+ * @return The new index i
* @since 1.0-alpha3
*/
private static int parseEscape(int i, final StringBuilder stringBuilder, final String string) throws ImagingException {
@@ -166,7 +166,7 @@ public class BasicCParser {
* @param is the input stream to preprocess.
* @param firstComment StringBuilder to capture the first comment, or null to ignore.
* @param defines map to store preprocessor definitions.
- * @return the preprocessed output as a ByteArrayOutputStream.
+ * @return The preprocessed output as a ByteArrayOutputStream.
* @throws IOException if an I/O error occurs.
* @throws ImagingException if parsing fails.
*/
@@ -354,7 +354,7 @@ public class BasicCParser {
* Tokenizes a row by splitting on whitespace.
*
* @param row the row to tokenize.
- * @return the array of tokens.
+ * @return The array of tokens.
*/
public static String[] tokenizeRow(final String row) {
final String[] tokens = row.split("[ \t]");
@@ -421,7 +421,7 @@ public class BasicCParser {
/**
* Reads the next token from the input stream.
*
- * @return the next token as a string, or null if end of stream.
+ * @return The next token as a string, or null if end of stream.
* @throws IOException if an I/O error occurs.
* @throws ImagingException if parsing fails.
*/
diff --git a/src/main/java/org/apache/commons/imaging/common/BinaryConstant.java b/src/main/java/org/apache/commons/imaging/common/BinaryConstant.java
index 9dff6415..225e341e 100644
--- a/src/main/java/org/apache/commons/imaging/common/BinaryConstant.java
+++ b/src/main/java/org/apache/commons/imaging/common/BinaryConstant.java
@@ -61,7 +61,7 @@ public class BinaryConstant {
* Gets the byte at the specified index.
*
* @param i the index.
- * @return the byte at the specified index.
+ * @return The byte at the specified index.
*/
public byte get(final int i) {
return value[i];
@@ -85,7 +85,7 @@ public class BinaryConstant {
/**
* Gets the raw byte array value (internal use).
*
- * @return the raw value.
+ * @return The raw value.
*/
byte[] rawValue() {
return value;
@@ -94,7 +94,7 @@ public class BinaryConstant {
/**
* Gets the size of this binary constant.
*
- * @return the size in bytes.
+ * @return The size in bytes.
*/
public int size() {
return value.length;
diff --git a/src/main/java/org/apache/commons/imaging/common/BinaryFileParser.java b/src/main/java/org/apache/commons/imaging/common/BinaryFileParser.java
index dcbd05df..5ff20245 100644
--- a/src/main/java/org/apache/commons/imaging/common/BinaryFileParser.java
+++ b/src/main/java/org/apache/commons/imaging/common/BinaryFileParser.java
@@ -96,7 +96,7 @@ public class BinaryFileParser {
/**
* Gets the byte order used by this parser.
*
- * @return the byte order.
+ * @return The byte order.
*/
public ByteOrder getByteOrder() {
return byteOrder;
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 1c3273fa..20430ad5 100644
--- a/src/main/java/org/apache/commons/imaging/common/BinaryFunctions.java
+++ b/src/main/java/org/apache/commons/imaging/common/BinaryFunctions.java
@@ -44,7 +44,7 @@ public final class BinaryFunctions {
* @param c2 the second character.
* @param c3 the third character.
* @param c4 the fourth character.
- * @return the 32-bit integer value.
+ * @return The 32-bit integer value.
*/
public static int charsToQuad(final char c1, final char c2, final char c3, final char c4) {
return (0xff & c1) << 24 | (0xff & c2) << 16 | (0xff & c3) << 8 | (0xff & c4) << 0;
@@ -108,7 +108,7 @@ public final class BinaryFunctions {
* @param pos the position to start reading.
* @param length the number of bytes to read.
* @param exception the exception message if length is invalid.
- * @return the bytes read.
+ * @return The bytes read.
* @throws IOException if an I/O error occurs or length is invalid.
*/
public static byte[] getBytes(final RandomAccessFile raf, final long pos, final int length, final String exception) throws IOException {
@@ -126,7 +126,7 @@ public final class BinaryFunctions {
* @param src the array to search for the object, may be {@code null}.
* @param start the index to start searching.
* @param message The ImagingException message if 0 is not found.
- * @return the index of the value within the array,
+ * @return The index of the value within the array,
* @throws ImagingException Thrown if 0 is not found.
*/
public static int indexOf0(final byte[] src, final int start, final String message) throws ImagingException {
@@ -142,7 +142,7 @@ public final class BinaryFunctions {
*
* @param src the array to search for the object, may be {@code null}.
* @param message The ImagingException message if 0 is not found.
- * @return the index of the value within the array,
+ * @return The index of the value within the array,
* @throws ImagingException Thrown if 0 is not found.
*/
public static int indexOf0(final byte[] src, final String message) throws ImagingException {
@@ -203,7 +203,7 @@ public final class BinaryFunctions {
* @param in the input stream.
* @param exception the exception message if read fails.
* @param byteOrder the byte order.
- * @return the 16-bit value.
+ * @return The 16-bit value.
* @throws IOException if an I/O error occurs.
*/
public static int read2Bytes(final String name, final InputStream in, final String exception, final ByteOrder byteOrder) throws IOException {
@@ -228,7 +228,7 @@ public final class BinaryFunctions {
* @param in the input stream.
* @param exception the exception message if read fails.
* @param byteOrder the byte order.
- * @return the 24-bit value.
+ * @return The 24-bit value.
* @throws IOException if an I/O error occurs.
*/
public static int read3Bytes(final String name, final InputStream in, final String exception, final ByteOrder byteOrder) throws IOException {
@@ -254,7 +254,7 @@ public final class BinaryFunctions {
* @param in the input stream.
* @param exception the exception message if read fails.
* @param byteOrder the byte order.
- * @return the 32-bit value.
+ * @return The 32-bit value.
* @throws IOException if an I/O error occurs.
*/
public static int read4Bytes(final String name, final InputStream in, final String exception, final ByteOrder byteOrder) throws IOException {
@@ -346,7 +346,7 @@ public final class BinaryFunctions {
* @param name the field name (for debugging).
* @param in the input stream.
* @param exceptionMessage the exception message if read fails.
- * @return the byte read.
+ * @return The byte read.
* @throws IOException if an I/O error occurs.
*/
public static byte readByte(final String name, final InputStream in, final String exceptionMessage) throws IOException {
@@ -362,7 +362,7 @@ public final class BinaryFunctions {
*
* @param in the input stream.
* @param count the number of bytes to read.
- * @return the bytes read.
+ * @return The bytes read.
* @throws IOException if an I/O error occurs.
*/
public static byte[] readBytes(final InputStream in, final int count) throws IOException {
@@ -375,7 +375,7 @@ public final class BinaryFunctions {
* @param name the field name (for debugging).
* @param in the input stream.
* @param length the number of bytes to read.
- * @return the bytes read.
+ * @return The bytes read.
* @throws IOException if an I/O error occurs.
*/
public static byte[] readBytes(final String name, final InputStream in, final int length) throws IOException {
@@ -389,7 +389,7 @@ public final class BinaryFunctions {
* @param in the input stream.
* @param length the number of bytes to read.
* @param exception the exception message if read fails.
- * @return the bytes read.
+ * @return The bytes read.
* @throws IOException if an I/O error occurs.
*/
public static byte[] readBytes(final String name, final InputStream in, final int length, final String exception) throws IOException {
@@ -406,7 +406,7 @@ public final class BinaryFunctions {
* @param name the field name (for debugging).
* @param bytes the source byte array.
* @param count the starting offset.
- * @return the remaining bytes.
+ * @return The remaining bytes.
*/
public static byte[] remainingBytes(final String name, final byte[] bytes, final int count) {
return copyOfRange(bytes, count, bytes.length - count);
@@ -446,7 +446,7 @@ public final class BinaryFunctions {
*
* @param in the input stream.
* @param skip the number of bytes to skip.
- * @return the number of bytes actually skipped.
+ * @return The number of bytes actually skipped.
* @throws IOException if an I/O error occurs.
*/
public static long skipBytes(final InputStream in, final long skip) throws IOException {
@@ -459,7 +459,7 @@ public final class BinaryFunctions {
* @param in the input stream.
* @param skip the number of bytes to skip.
* @param exMessage the exception message if skip fails.
- * @return the number of bytes actually skipped.
+ * @return The number of bytes actually skipped.
* @throws IOException if an I/O error occurs.
*/
public static long skipBytes(final InputStream in, final long skip, final String exMessage) throws IOException {
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 be03973e..3f63ddf1 100644
--- a/src/main/java/org/apache/commons/imaging/common/ByteConversions.java
+++ b/src/main/java/org/apache/commons/imaging/common/ByteConversions.java
@@ -29,7 +29,7 @@ public final class ByteConversions {
*
* @param value the double value.
* @param byteOrder the byte order.
- * @return the byte array.
+ * @return The byte array.
*/
public static byte[] toBytes(final double value, final ByteOrder byteOrder) {
final byte[] result = new byte[8];
@@ -65,7 +65,7 @@ public final class ByteConversions {
*
* @param values the double array.
* @param byteOrder the byte order.
- * @return the byte array.
+ * @return The byte array.
*/
public static byte[] toBytes(final double[] values, final ByteOrder byteOrder) {
return toBytes(values, 0, values.length, byteOrder);
@@ -84,7 +84,7 @@ public final class ByteConversions {
*
* @param value the float value.
* @param byteOrder the byte order.
- * @return the byte array.
+ * @return The byte array.
*/
public static byte[] toBytes(final float value, final ByteOrder byteOrder) {
final byte[] result = new byte[4];
@@ -112,7 +112,7 @@ public final class ByteConversions {
*
* @param values the float array.
* @param byteOrder the byte order.
- * @return the byte array.
+ * @return The byte array.
*/
public static byte[] toBytes(final float[] values, final ByteOrder byteOrder) {
return toBytes(values, 0, values.length, byteOrder);
@@ -131,7 +131,7 @@ public final class ByteConversions {
*
* @param value the int value.
* @param byteOrder the byte order.
- * @return the byte array.
+ * @return The byte array.
*/
public static byte[] toBytes(final int value, final ByteOrder byteOrder) {
final byte[] result = new byte[4];
@@ -158,7 +158,7 @@ public final class ByteConversions {
*
* @param values the int array.
* @param byteOrder the byte order.
- * @return the byte array.
+ * @return The byte array.
*/
public static byte[] toBytes(final int[] values, final ByteOrder byteOrder) {
return toBytes(values, 0, values.length, byteOrder);
@@ -212,7 +212,7 @@ public final class ByteConversions {
*
* @param value the RationalNumber.
* @param byteOrder the byte order.
- * @return the byte array.
+ * @return The byte array.
*/
public static byte[] toBytes(final RationalNumber value, final ByteOrder byteOrder) {
final byte[] result = new byte[8];
@@ -247,7 +247,7 @@ public final class ByteConversions {
*
* @param values the RationalNumber array.
* @param byteOrder the byte order.
- * @return the byte array.
+ * @return The byte array.
*/
public static byte[] toBytes(final RationalNumber[] values, final ByteOrder byteOrder) {
return toBytes(values, 0, values.length, byteOrder);
@@ -266,7 +266,7 @@ public final class ByteConversions {
*
* @param value the short value.
* @param byteOrder the byte order.
- * @return the byte array.
+ * @return The byte array.
*/
public static byte[] toBytes(final short value, final ByteOrder byteOrder) {
final byte[] result = new byte[2];
@@ -289,7 +289,7 @@ public final class ByteConversions {
*
* @param values the short array.
* @param byteOrder the byte order.
- * @return the byte array.
+ * @return The byte array.
*/
public static byte[] toBytes(final short[] values, final ByteOrder byteOrder) {
return toBytes(values, 0, values.length, byteOrder);
@@ -308,7 +308,7 @@ public final class ByteConversions {
*
* @param bytes the byte array.
* @param byteOrder the byte order.
- * @return the double value.
+ * @return The double value.
*/
public static double toDouble(final byte[] bytes, final ByteOrder byteOrder) {
return toDouble(bytes, 0, byteOrder);
@@ -337,7 +337,7 @@ public final class ByteConversions {
*
* @param bytes the byte array.
* @param byteOrder the byte order.
- * @return the double array.
+ * @return The double array.
*/
public static double[] toDoubles(final byte[] bytes, final ByteOrder byteOrder) {
return toDoubles(bytes, 0, bytes.length, byteOrder);
@@ -354,7 +354,7 @@ public final class ByteConversions {
*
* @param bytes the byte array.
* @param byteOrder the byte order.
- * @return the float value.
+ * @return The float value.
*/
public static float toFloat(final byte[] bytes, final ByteOrder byteOrder) {
return toFloat(bytes, 0, byteOrder);
@@ -379,7 +379,7 @@ public final class ByteConversions {
*
* @param bytes the byte array.
* @param byteOrder the byte order.
- * @return the float array.
+ * @return The float array.
*/
public static float[] toFloats(final byte[] bytes, final ByteOrder byteOrder) {
return toFloats(bytes, 0, bytes.length, byteOrder);
@@ -398,7 +398,7 @@ public final class ByteConversions {
*
* @param bytes the byte array.
* @param byteOrder the byte order.
- * @return the int value.
+ * @return The int value.
*/
public static int toInt(final byte[] bytes, final ByteOrder byteOrder) {
return toInt(bytes, 0, byteOrder);
@@ -410,7 +410,7 @@ public final class ByteConversions {
* @param bytes the byte array.
* @param offset the starting offset.
* @param byteOrder the byte order.
- * @return the int value.
+ * @return The int value.
*/
public static int toInt(final byte[] bytes, final int offset, final ByteOrder byteOrder) {
final int byte0 = 0xff & bytes[offset + 0];
@@ -428,7 +428,7 @@ public final class ByteConversions {
*
* @param bytes the byte array.
* @param byteOrder the byte order.
- * @return the int array.
+ * @return The int array.
*/
public static int[] toInts(final byte[] bytes, final ByteOrder byteOrder) {
return toInts(bytes, 0, bytes.length, byteOrder);
@@ -525,7 +525,7 @@ public final class ByteConversions {
* @param bytes the byte array.
* @param byteOrder the byte order.
* @param unsignedType indicates whether the extracted value is an unsigned type.
- * @return the RationalNumber array.
+ * @return The RationalNumber array.
*/
public static RationalNumber[] toRationals(final byte[] bytes, final ByteOrder byteOrder, final boolean unsignedType) {
return toRationals(bytes, 0, bytes.length, byteOrder, unsignedType);
@@ -542,7 +542,7 @@ public final class ByteConversions {
*
* @param bytes the byte array.
* @param byteOrder the byte order.
- * @return the short value.
+ * @return The short value.
*/
public static short toShort(final byte[] bytes, final ByteOrder byteOrder) {
return toShort(bytes, 0, byteOrder);
@@ -557,7 +557,7 @@ public final class ByteConversions {
*
* @param bytes the byte array.
* @param byteOrder the byte order.
- * @return the short array.
+ * @return The short array.
*/
public static short[] toShorts(final byte[] bytes, final ByteOrder byteOrder) {
return toShorts(bytes, 0, bytes.length, byteOrder);
@@ -576,7 +576,7 @@ public final class ByteConversions {
*
* @param bytes the byte array.
* @param byteOrder the byte order.
- * @return the unsigned 16-bit integer value.
+ * @return The unsigned 16-bit integer value.
*/
public static int toUInt16(final byte[] bytes, final ByteOrder byteOrder) {
return toUInt16(bytes, 0, byteOrder);
@@ -588,7 +588,7 @@ public final class ByteConversions {
* @param bytes the byte array.
* @param offset the starting offset.
* @param byteOrder the byte order.
- * @return the unsigned 16-bit integer value.
+ * @return The unsigned 16-bit integer value.
*/
public static int toUInt16(final byte[] bytes, final int offset, final ByteOrder byteOrder) {
final int byte0 = 0xff & bytes[offset + 0];
@@ -604,7 +604,7 @@ public final class ByteConversions {
*
* @param bytes the byte array.
* @param byteOrder the byte order.
- * @return the array of unsigned 16-bit integers.
+ * @return The array of unsigned 16-bit integers.
*/
public static int[] toUInt16s(final byte[] bytes, final ByteOrder byteOrder) {
return toUInt16s(bytes, 0, bytes.length, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/common/GenericImageMetadata.java b/src/main/java/org/apache/commons/imaging/common/GenericImageMetadata.java
index 7cfea91a..2d9f1e80 100644
--- a/src/main/java/org/apache/commons/imaging/common/GenericImageMetadata.java
+++ b/src/main/java/org/apache/commons/imaging/common/GenericImageMetadata.java
@@ -46,7 +46,7 @@ public class GenericImageMetadata implements ImageMetadata {
/**
* Gets the keyword.
*
- * @return the keyword.
+ * @return The keyword.
*/
public String getKeyword() {
return keyword;
@@ -55,7 +55,7 @@ public class GenericImageMetadata implements ImageMetadata {
/**
* Gets the text value.
*
- * @return the text value.
+ * @return The text value.
*/
public String getText() {
return text;
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 c038b9fe..294c2885 100644
--- a/src/main/java/org/apache/commons/imaging/common/ImageBuilder.java
+++ b/src/main/java/org/apache/commons/imaging/common/ImageBuilder.java
@@ -162,7 +162,7 @@ public final class ImageBuilder {
*
* @param x the X coordinate of the pixel to be read
* @param y the Y coordinate of the pixel to be read
- * @return the RGB or ARGB pixel value
+ * @return The RGB or ARGB pixel value
*/
public int getRgb(final int x, final int y) {
final int rowOffset = y * width;
diff --git a/src/main/java/org/apache/commons/imaging/common/ImageMetadata.java b/src/main/java/org/apache/commons/imaging/common/ImageMetadata.java
index 6ecc67d1..756f0a78 100644
--- a/src/main/java/org/apache/commons/imaging/common/ImageMetadata.java
+++ b/src/main/java/org/apache/commons/imaging/common/ImageMetadata.java
@@ -34,7 +34,7 @@ public interface ImageMetadata {
* Gets a string representation with a prefix.
*
* @param prefix the prefix to use.
- * @return the string representation.
+ * @return The string representation.
*/
String toString(String prefix);
}
@@ -42,7 +42,7 @@ public interface ImageMetadata {
/**
* Gets the list of metadata items.
*
- * @return the list of metadata items.
+ * @return The list of metadata items.
*/
List<? extends ImageMetadataItem> getItems();
@@ -50,7 +50,7 @@ public interface ImageMetadata {
* Gets a string representation with a prefix.
*
* @param prefix the prefix to use.
- * @return the string representation.
+ * @return The string representation.
*/
String toString(String prefix);
}
diff --git a/src/main/java/org/apache/commons/imaging/common/PackBits.java b/src/main/java/org/apache/commons/imaging/common/PackBits.java
index d111ff0f..9069c65a 100644
--- a/src/main/java/org/apache/commons/imaging/common/PackBits.java
+++ b/src/main/java/org/apache/commons/imaging/common/PackBits.java
@@ -31,7 +31,7 @@ public final class PackBits {
* Compresses byte data using PackBits compression.
*
* @param bytes the bytes to compress.
- * @return the compressed bytes.
+ * @return The compressed bytes.
* @throws IOException if an I/O error occurs.
*/
public static byte[] compress(final byte[] bytes) throws IOException {
@@ -88,7 +88,7 @@ public final class PackBits {
*
* @param bytes the compressed bytes.
* @param expected the expected number of decompressed bytes.
- * @return the decompressed bytes.
+ * @return The decompressed bytes.
* @throws ImagingException if the data is corrupt or incomplete.
*/
public static byte[] decompress(final byte[] bytes, final int expected) throws ImagingException {
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 206070e5..46fc9308 100644
--- a/src/main/java/org/apache/commons/imaging/common/RationalNumber.java
+++ b/src/main/java/org/apache/commons/imaging/common/RationalNumber.java
@@ -93,7 +93,7 @@ public class RationalNumber extends Number {
* Calculate rational number using successive approximations.
*
* @param value rational number double value
- * @return the RationalNumber representation of the double value
+ * @return The RationalNumber representation of the double value
*/
public static RationalNumber valueOf(double value) {
if (value >= Integer.MAX_VALUE) {
@@ -287,7 +287,7 @@ public class RationalNumber extends Number {
/**
* Converts to display string.
*
- * @return the display string.
+ * @return The display string.
*/
public String toDisplayString() {
if (numerator % divisor == 0) {
diff --git a/src/main/java/org/apache/commons/imaging/common/XmpImagingParameters.java b/src/main/java/org/apache/commons/imaging/common/XmpImagingParameters.java
index 1462d889..452d9172 100644
--- a/src/main/java/org/apache/commons/imaging/common/XmpImagingParameters.java
+++ b/src/main/java/org/apache/commons/imaging/common/XmpImagingParameters.java
@@ -39,7 +39,7 @@ public class XmpImagingParameters<E extends XmpImagingParameters<E>> extends Ima
/**
* Gets the XMP XML.
*
- * @return the XMP XML.
+ * @return The XMP XML.
*/
public String getXmpXml() {
return xmpXml;
diff --git a/src/main/java/org/apache/commons/imaging/formats/bmp/BmpImageParser.java b/src/main/java/org/apache/commons/imaging/formats/bmp/BmpImageParser.java
index f951dbe2..6e33c085 100644
--- a/src/main/java/org/apache/commons/imaging/formats/bmp/BmpImageParser.java
+++ b/src/main/java/org/apache/commons/imaging/formats/bmp/BmpImageParser.java
@@ -130,7 +130,7 @@ public class BmpImageParser extends AbstractImageParser<BmpImagingParameters> {
*
* @param inputStream the input stream to read from.
* @param params the imaging parameters.
- * @return the BufferedImage.
+ * @return The BufferedImage.
* @throws ImagingException if the image format is invalid.
* @throws IOException if an I/O error occurs.
*/
diff --git a/src/main/java/org/apache/commons/imaging/formats/gif/GifImageMetadata.java b/src/main/java/org/apache/commons/imaging/formats/gif/GifImageMetadata.java
index ab5abe45..5e5ac6ea 100644
--- a/src/main/java/org/apache/commons/imaging/formats/gif/GifImageMetadata.java
+++ b/src/main/java/org/apache/commons/imaging/formats/gif/GifImageMetadata.java
@@ -41,7 +41,7 @@ public class GifImageMetadata implements ImageMetadata {
/**
* Gets the image height.
*
- * @return the height in pixels.
+ * @return The height in pixels.
*/
public int getHeight() {
return height;
@@ -55,7 +55,7 @@ public class GifImageMetadata implements ImageMetadata {
/**
* Gets the image width.
*
- * @return the width in pixels.
+ * @return The width in pixels.
*/
public int getWidth() {
return width;
diff --git a/src/main/java/org/apache/commons/imaging/formats/gif/GifImageMetadataItem.java b/src/main/java/org/apache/commons/imaging/formats/gif/GifImageMetadataItem.java
index 433d999d..9e3bbed7 100644
--- a/src/main/java/org/apache/commons/imaging/formats/gif/GifImageMetadataItem.java
+++ b/src/main/java/org/apache/commons/imaging/formats/gif/GifImageMetadataItem.java
@@ -38,7 +38,7 @@ public class GifImageMetadataItem implements ImageMetadata.ImageMetadataItem {
/**
* Gets the frame delay in milliseconds.
*
- * @return the delay.
+ * @return The delay.
*/
public int getDelay() {
return delay;
@@ -47,7 +47,7 @@ public class GifImageMetadataItem implements ImageMetadata.ImageMetadataItem {
/**
* Gets the disposal method for this frame.
*
- * @return the disposal method.
+ * @return The disposal method.
*/
public DisposalMethod getDisposalMethod() {
return disposalMethod;
@@ -56,7 +56,7 @@ public class GifImageMetadataItem implements ImageMetadata.ImageMetadataItem {
/**
* Gets the left position of the frame.
*
- * @return the left position in pixels.
+ * @return The left position in pixels.
*/
public int getLeftPosition() {
return leftPosition;
@@ -65,7 +65,7 @@ public class GifImageMetadataItem implements ImageMetadata.ImageMetadataItem {
/**
* Gets the top position of the frame.
*
- * @return the top position in pixels.
+ * @return The top position in pixels.
*/
public int getTopPosition() {
return topPosition;
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/JpegImageMetadata.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/JpegImageMetadata.java
index 3f4d98ed..b58443af 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/JpegImageMetadata.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/JpegImageMetadata.java
@@ -66,7 +66,7 @@ public class JpegImageMetadata implements ImageMetadata {
* Finds an EXIF value.
*
* @param tagInfo the tag info.
- * @return the TIFF field or null if not found.
+ * @return The TIFF field or null if not found.
*/
public TiffField findExifValue(final TagInfo tagInfo) {
try {
@@ -80,7 +80,7 @@ public class JpegImageMetadata implements ImageMetadata {
* Finds an EXIF value with exact match.
*
* @param tagInfo the tag info.
- * @return the TIFF field or null if not found.
+ * @return The TIFF field or null if not found.
*/
public TiffField findExifValueWithExactMatch(final TagInfo tagInfo) {
try {
@@ -93,7 +93,7 @@ public class JpegImageMetadata implements ImageMetadata {
/**
* Gets the EXIF metadata.
*
- * @return the EXIF metadata.
+ * @return The EXIF metadata.
*/
public TiffImageMetadata getExif() {
return exif;
@@ -102,7 +102,7 @@ public class JpegImageMetadata implements ImageMetadata {
/**
* Gets the thumbnail image if available.
*
- * @return the thumbnail image. May be {@code null} if no image could be found.
+ * @return The thumbnail image. May be {@code null} if no image could be found.
* @throws ImagingException if it fails to read the image.
* @throws IOException if it fails to get the thumbnail or to read the image data.
*/
@@ -207,7 +207,7 @@ public class JpegImageMetadata implements ImageMetadata {
/**
* Gets the Photoshop metadata.
*
- * @return the Photoshop metadata.
+ * @return The Photoshop metadata.
*/
public JpegPhotoshopMetadata getPhotoshop() {
return photoshop;
@@ -216,7 +216,7 @@ public class JpegImageMetadata implements ImageMetadata {
/**
* Gets the raw image data.
*
- * @return the raw image data or null if not found.
+ * @return The raw image data or null if not found.
*/
public AbstractTiffImageData getRawImageData() {
if (exif == null) {
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/JpegImageParser.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/JpegImageParser.java
index 2a8d9196..44517636 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/JpegImageParser.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/JpegImageParser.java
@@ -240,7 +240,7 @@ public class JpegImageParser extends AbstractImageParser<JpegImagingParameters>
*
* @param byteSource the byte source.
* @param params the TIFF imaging parameters.
- * @return the EXIF metadata or null if not found.
+ * @return The EXIF metadata or null if not found.
* @throws ImagingException if an imaging error occurs.
* @throws IOException if an I/O error occurs.
*/
@@ -262,7 +262,7 @@ public class JpegImageParser extends AbstractImageParser<JpegImagingParameters>
* Gets raw EXIF data.
*
* @param byteSource the byte source.
- * @return the raw EXIF data or null if not found.
+ * @return The raw EXIF data or null if not found.
* @throws ImagingException if an imaging error occurs.
* @throws IOException if an I/O error occurs.
*/
@@ -694,7 +694,7 @@ public class JpegImageParser extends AbstractImageParser<JpegImagingParameters>
*
* @param byteSource the byte source.
* @param params the imaging parameters.
- * @return the Photoshop metadata or null if not found.
+ * @return The Photoshop metadata or null if not found.
* @throws ImagingException if an imaging error occurs.
* @throws IOException if an I/O error occurs.
*/
@@ -922,7 +922,7 @@ public class JpegImageParser extends AbstractImageParser<JpegImagingParameters>
* @param byteSource the byte source.
* @param markers the markers to read.
* @param returnAfterFirst whether to return after first match.
- * @return the list of segments.
+ * @return The list of segments.
* @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/formats/jpeg/JpegUtils.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/JpegUtils.java
index 5b56aa2b..d8a13ff5 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/JpegUtils.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/JpegUtils.java
@@ -73,7 +73,7 @@ public class JpegUtils extends BinaryFileParser {
* Gets the marker name.
*
* @param marker the marker.
- * @return the marker name.
+ * @return The marker name.
*/
public static String getMarkerName(final int marker) {
switch (marker) {
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/decoder/JpegDecoder.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/decoder/JpegDecoder.java
index 0719f695..b1360c3a 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/decoder/JpegDecoder.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/decoder/JpegDecoder.java
@@ -68,7 +68,7 @@ public class JpegDecoder extends BinaryFileParser implements JpegUtils.Visitor {
* of restart markers found is equal to the number of start positions minus one (because restart markers are between intervals).
*
* @param scanPayload array to examine
- * @return the start positions
+ * @return The start positions
*/
static List<Integer> getIntervalStartPositions(final int[] scanPayload) {
final List<Integer> intervalStarts = new ArrayList<>();
@@ -183,7 +183,7 @@ public class JpegDecoder extends BinaryFileParser implements JpegUtils.Visitor {
* Decodes a JPEG image from a byte source.
*
* @param byteSource the byte source containing the JPEG data.
- * @return the decoded BufferedImage.
+ * @return The decoded BufferedImage.
* @throws IOException if an I/O error occurs.
* @throws ImagingException if an imaging error occurs.
*/
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/decoder/JpegInputStream.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/decoder/JpegInputStream.java
index 7fb5f7aa..abf6dd7b 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/decoder/JpegInputStream.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/decoder/JpegInputStream.java
@@ -72,7 +72,7 @@ final class JpegInputStream {
/**
* Returns the value from current field (as {@code InputStream.read()} would do) and set the position of the pointer to the next field to read.
*
- * @return the value from current field (as {@code InputStream.read()} would do).
+ * @return The value from current field (as {@code InputStream.read()} would do).
* @throws IllegalStateException if the stream hasn't any other value.
*/
int read() {
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 7e3c677d..48c154e8 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
@@ -64,7 +64,7 @@ public class IptcBlock {
/**
* Gets the block type.
*
- * @return the block type.
+ * @return The block type.
*/
public int getBlockType() {
return blockType;
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 e874f203..e326a04f 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
@@ -349,7 +349,7 @@ public class IptcParser extends BinaryFileParser {
*
* @param bytes the segment data bytes.
* @param strict whether to use strict parsing mode.
- * @return the parsed Photoshop APP13 data.
+ * @return The parsed Photoshop APP13 data.
* @throws ImagingException if an imaging error occurs.
* @throws IOException if an I/O error occurs.
*/
@@ -401,7 +401,7 @@ public class IptcParser extends BinaryFileParser {
*
* @param bytes the segment data bytes.
* @param params the imaging parameters.
- * @return the parsed Photoshop APP13 data.
+ * @return The parsed Photoshop APP13 data.
* @throws ImagingException if an imaging error occurs.
* @throws IOException if an I/O error occurs.
*/
@@ -416,7 +416,7 @@ public class IptcParser extends BinaryFileParser {
* Writes IPTC records to a byte array block.
*
* @param elements the list of IPTC records to write.
- * @return the byte array containing the IPTC block.
+ * @return The byte array containing the IPTC block.
* @throws ImagingException if an imaging error occurs.
* @throws IOException if an I/O error occurs.
*/
@@ -429,7 +429,7 @@ public class IptcParser extends BinaryFileParser {
*
* @param elements the list of IPTC records to write.
* @param forceUtf8Encoding whether to force UTF-8 encoding.
- * @return the byte array containing the IPTC block.
+ * @return The byte array containing the IPTC block.
* @throws ImagingException if an imaging error occurs.
* @throws IOException if an I/O error occurs.
*/
@@ -508,7 +508,7 @@ public class IptcParser extends BinaryFileParser {
* Writes Photoshop APP13 segment data.
*
* @param data the Photoshop APP13 data to write.
- * @return the byte array containing the APP13 segment.
+ * @return The byte array containing the APP13 segment.
* @throws IOException if an I/O error occurs.
* @throws ImagingException if an imaging error occurs.
*/
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcRecord.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcRecord.java
index 1ffda6e8..663c3434 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcRecord.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcRecord.java
@@ -44,7 +44,7 @@ public class IptcRecord {
/**
* Gets the IPTC type name.
*
- * @return the IPTC type name.
+ * @return The IPTC type name.
*/
public String getIptcTypeName() {
return iptcType.getName();
@@ -53,7 +53,7 @@ public class IptcRecord {
/**
* Gets the value.
*
- * @return the value.
+ * @return The value.
*/
public String getValue() {
return value;
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcType.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcType.java
index b506cfc7..41aecc18 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcType.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcType.java
@@ -24,14 +24,14 @@ public interface IptcType {
/**
* Gets the name of this IPTC type.
*
- * @return the name.
+ * @return The name.
*/
String getName();
/**
* Gets the type number.
*
- * @return the type number.
+ * @return The type number.
*/
int getType();
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/AbstractGenericSegment.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/AbstractGenericSegment.java
index eb7bca7a..e272970e 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/AbstractGenericSegment.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/AbstractGenericSegment.java
@@ -75,7 +75,7 @@ public abstract class AbstractGenericSegment extends AbstractSegment {
/**
* Returns a copy of the segment's contents, excluding the marker and length bytes at the beginning.
*
- * @return the segment's contents.
+ * @return The segment's contents.
*/
public byte[] getSegmentData() {
return segmentData.clone();
@@ -85,7 +85,7 @@ public abstract class AbstractGenericSegment extends AbstractSegment {
* Returns a specific byte of the segment's contents, excluding the marker and length bytes at the beginning.
*
* @param offset segment offset.
- * @return the bye in the segment's contents.
+ * @return The bye in the segment's contents.
* @see AbstractGenericSegment#getSegmentData()
*/
protected byte getSegmentData(final int offset) {
@@ -96,7 +96,7 @@ public abstract class AbstractGenericSegment extends AbstractSegment {
* Convert the bytes to a String
*
* @param encoding segment encoding
- * @return the encoded bytes
+ * @return The encoded bytes
*/
public String getSegmentDataAsString(final Charset encoding) {
return new String(segmentData, encoding);
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/AbstractSegment.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/AbstractSegment.java
index 885f2186..d79ff566 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/AbstractSegment.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/AbstractSegment.java
@@ -54,14 +54,14 @@ public abstract class AbstractSegment extends BinaryFileParser {
/**
* Gets the description.
*
- * @return the description.
+ * @return The description.
*/
public abstract String getDescription();
/**
* Gets the type.
*
- * @return the type.
+ * @return The type.
*/
public String getSegmentType() {
switch (marker) {
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/App13Segment.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/App13Segment.java
index 4f177a8d..31c67921 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/App13Segment.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/App13Segment.java
@@ -81,7 +81,7 @@ public class App13Segment extends AppnSegment {
* Parses the Photoshop segment data.
*
* @param params the imaging parameters.
- * @return the parsed Photoshop APP13 data, or {@code null} if not a Photoshop segment.
+ * @return The parsed Photoshop APP13 data, or {@code null} if not a Photoshop segment.
* @throws ImagingException if the image format is invalid.
* @throws IOException if an I/O error occurs.
*/
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/App14Segment.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/App14Segment.java
index 623902b9..fd513432 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/App14Segment.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/App14Segment.java
@@ -70,7 +70,7 @@ public class App14Segment extends AppnSegment {
/**
* Gets the Adobe color transform value.
*
- * @return the color transform value.
+ * @return The color transform value.
*/
public int getAdobeColorTransform() {
return 0xff & getSegmentData(11);
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/App2Segment.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/App2Segment.java
index 40bc9960..7b6ee6ba 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/App2Segment.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/App2Segment.java
@@ -100,7 +100,7 @@ public final class App2Segment extends AppnSegment implements Comparable<App2Seg
/**
* Gets the ICC profile bytes.
*
- * @return the ICC bytes, or {@code null} if not present.
+ * @return The ICC bytes, or {@code null} if not present.
*/
public byte[] getIccBytes() {
return iccBytes != null ? iccBytes.clone() : null;
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/DhtSegment.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/DhtSegment.java
index a8b602d0..8f2a1e30 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/DhtSegment.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/DhtSegment.java
@@ -132,7 +132,7 @@ public final class DhtSegment extends AbstractSegment {
* Gets the Huffman value at the specified index.
*
* @param i the index.
- * @return the Huffman value.
+ * @return The Huffman value.
*/
public int getHuffVal(final int i) {
return huffVal[i];
@@ -142,7 +142,7 @@ public final class DhtSegment extends AbstractSegment {
* Gets the maximum code for the specified bit length.
*
* @param i the bit length.
- * @return the maximum code.
+ * @return The maximum code.
*/
public int getMaxCode(final int i) {
return maxCode[i];
@@ -152,7 +152,7 @@ public final class DhtSegment extends AbstractSegment {
* Gets the minimum code for the specified bit length.
*
* @param i the bit length.
- * @return the minimum code.
+ * @return The minimum code.
*/
public int getMinCode(final int i) {
return minCode[i];
@@ -162,7 +162,7 @@ public final class DhtSegment extends AbstractSegment {
* Gets the value pointer for the specified bit length.
*
* @param i the bit length.
- * @return the value pointer.
+ * @return The value pointer.
*/
public int getValPtr(final int i) {
return valPtr[i];
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/DqtSegment.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/DqtSegment.java
index 8f1a1481..f1b5ef3d 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/DqtSegment.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/DqtSegment.java
@@ -60,7 +60,7 @@ public final class DqtSegment extends AbstractSegment {
/**
* Gets the quantization table elements.
*
- * @return the elements.
+ * @return The elements.
*/
public int[] getElements() {
return elements;
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/SofnSegment.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/SofnSegment.java
index 5a7f207b..f9dc9b7f 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/SofnSegment.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/SofnSegment.java
@@ -136,7 +136,7 @@ public final class SofnSegment extends AbstractSegment {
/**
* Returns a copy of all the components.
*
- * @return the components
+ * @return The components
*/
public Component[] getComponents() {
return components.clone();
@@ -146,7 +146,7 @@ public final class SofnSegment extends AbstractSegment {
* Returns the component at the specified index.
*
* @param index the array index
- * @return the component
+ * @return The component
*/
public Component getComponents(final int index) {
return components[index];
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/SosSegment.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/SosSegment.java
index 7bcc7efa..1510e497 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/SosSegment.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/SosSegment.java
@@ -151,7 +151,7 @@ public final class SosSegment extends AbstractSegment {
* Gets a component at the specified index.
*
* @param index the component index
- * @return the component
+ * @return The component
*/
public Component getComponents(final int index) {
return components[index];
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/xmp/JpegRewriter.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/xmp/JpegRewriter.java
index be2e567a..33930288 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/xmp/JpegRewriter.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/xmp/JpegRewriter.java
@@ -152,7 +152,7 @@ public class JpegRewriter extends BinaryFileParser {
/**
* Gets the segment data.
*
- * @return the segment data.
+ * @return The segment data.
*/
public byte[] getSegmentData() {
return segmentData.clone();
@@ -268,7 +268,7 @@ public class JpegRewriter extends BinaryFileParser {
* Analyzes JFIF structure.
*
* @param byteSource the byte source.
- * @return the JFIF pieces.
+ * @return The JFIF pieces.
* @throws ImagingException if an imaging error occurs.
* @throws IOException if an I/O error occurs.
*/
@@ -311,7 +311,7 @@ public class JpegRewriter extends BinaryFileParser {
* @param <T> The piece type.
* @param segments the segments.
* @param filter the filter.
- * @return the filtered segments.
+ * @return The filtered segments.
*/
protected <T extends JFIFPiece> List<T> filterSegments(final List<T> segments, final SegmentFilter filter) {
return filterSegments(segments, filter, false);
@@ -324,7 +324,7 @@ public class JpegRewriter extends BinaryFileParser {
* @param segments the segments.
* @param filter the filter.
* @param reverse whether to reverse the filter logic.
- * @return the filtered segments.
+ * @return The filtered segments.
*/
protected <T extends JFIFPiece> List<T> filterSegments(final List<T> segments, final SegmentFilter filter, final boolean reverse) {
final List<T> result = new ArrayList<>();
@@ -347,7 +347,7 @@ public class JpegRewriter extends BinaryFileParser {
*
* @param <T> The piece type.
* @param segments the segments.
- * @return the filtered segments.
+ * @return The filtered segments.
*/
protected <T extends JFIFPiece> List<T> findPhotoshopApp13Segments(final List<T> segments) {
return filterSegments(segments, PHOTOSHOP_APP13_SEGMENT_FILTER, true);
@@ -360,7 +360,7 @@ public class JpegRewriter extends BinaryFileParser {
* @param <U> The new piece type.
* @param segments the segments.
* @param newSegments the new segments to insert.
- * @return the combined segments.
+ * @return The combined segments.
* @throws ImagingException if an imaging error occurs.
*/
protected <T extends JFIFPiece, U extends JFIFPiece> List<JFIFPiece> insertAfterLastAppSegments(final List<T> segments, final List<U> newSegments)
@@ -398,7 +398,7 @@ public class JpegRewriter extends BinaryFileParser {
* @param <U> The new piece type.
* @param segments the segments.
* @param newSegments the new segments to insert.
- * @return the combined segments.
+ * @return The combined segments.
* @throws ImagingException if an imaging error occurs.
*/
protected <T extends JFIFPiece, U extends JFIFPiece> List<JFIFPiece> insertBeforeFirstAppSegments(final List<T> segments, final List<U> newSegments)
@@ -429,7 +429,7 @@ public class JpegRewriter extends BinaryFileParser {
*
* @param <T> The piece type.
* @param segments the segments.
- * @return the filtered segments.
+ * @return The filtered segments.
*/
protected <T extends JFIFPiece> List<T> removeExifSegments(final List<T> segments) {
return filterSegments(segments, EXIF_SEGMENT_FILTER);
@@ -440,7 +440,7 @@ public class JpegRewriter extends BinaryFileParser {
*
* @param <T> The piece type.
* @param segments the segments.
- * @return the filtered segments.
+ * @return The filtered segments.
*/
protected <T extends JFIFPiece> List<T> removePhotoshopApp13Segments(final List<T> segments) {
return filterSegments(segments, PHOTOSHOP_APP13_SEGMENT_FILTER);
@@ -451,7 +451,7 @@ public class JpegRewriter extends BinaryFileParser {
*
* @param <T> The piece type.
* @param segments the segments.
- * @return the filtered segments.
+ * @return The filtered segments.
*/
protected <T extends JFIFPiece> List<T> removeXmpSegments(final List<T> segments) {
return filterSegments(segments, XMP_SEGMENT_FILTER);
diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/xmp/JpegXmpParser.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/xmp/JpegXmpParser.java
index ea399892..d3060573 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/xmp/JpegXmpParser.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/xmp/JpegXmpParser.java
@@ -49,7 +49,7 @@ public class JpegXmpParser extends BinaryFileParser {
* Parses XMP metadata from a JPEG segment.
*
* @param segmentData the segment data.
- * @return the XMP metadata as a string.
+ * @return The XMP metadata as a string.
* @throws ImagingException if the segment is not a valid XMP segment.
*/
public String parseXmpJpegSegment(final byte[] segmentData) throws ImagingException {
diff --git a/src/main/java/org/apache/commons/imaging/formats/pcx/PcxImagingParameters.java b/src/main/java/org/apache/commons/imaging/formats/pcx/PcxImagingParameters.java
index eafaef65..c7d639b8 100644
--- a/src/main/java/org/apache/commons/imaging/formats/pcx/PcxImagingParameters.java
+++ b/src/main/java/org/apache/commons/imaging/formats/pcx/PcxImagingParameters.java
@@ -38,7 +38,7 @@ public class PcxImagingParameters extends ImagingParameters<PcxImagingParameters
/**
* Gets the bit depth.
*
- * @return the bit depth.
+ * @return The bit depth.
*/
public int getBitDepth() {
return bitDepth;
@@ -47,7 +47,7 @@ public class PcxImagingParameters extends ImagingParameters<PcxImagingParameters
/**
* Gets the compression type.
*
- * @return the compression type.
+ * @return The compression type.
*/
public int getCompression() {
return compression;
@@ -56,7 +56,7 @@ public class PcxImagingParameters extends ImagingParameters<PcxImagingParameters
/**
* Gets the number of planes.
*
- * @return the number of planes.
+ * @return The number of planes.
*/
public int getPlanes() {
return planes;
diff --git a/src/main/java/org/apache/commons/imaging/formats/png/GammaCorrection.java b/src/main/java/org/apache/commons/imaging/formats/png/GammaCorrection.java
index 8766e49b..262200f4 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/GammaCorrection.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/GammaCorrection.java
@@ -54,7 +54,7 @@ public class GammaCorrection {
* Corrects an ARGB pixel value for gamma.
*
* @param pixel the ARGB pixel value.
- * @return the gamma-corrected pixel value.
+ * @return The gamma-corrected pixel value.
*/
public int correctArgb(final int pixel) {
final int alpha = 0xff000000 & pixel;
@@ -73,7 +73,7 @@ public class GammaCorrection {
* Corrects a sample value using the lookup table.
*
* @param sample the sample value.
- * @return the corrected sample value.
+ * @return The corrected sample value.
*/
public int correctSample(final int sample) {
return lookupTable[sample];
diff --git a/src/main/java/org/apache/commons/imaging/formats/png/PhysicalScale.java b/src/main/java/org/apache/commons/imaging/formats/png/PhysicalScale.java
index 9da57f93..fa067286 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/PhysicalScale.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/PhysicalScale.java
@@ -31,7 +31,7 @@ public final class PhysicalScale {
*
* @param x horizontal units per pixel in meters.
* @param y vertical units per pixel in meters.
- * @return the physical scale.
+ * @return The physical scale.
*/
public static PhysicalScale createFromMeters(final double x, final double y) {
return new PhysicalScale(METER_UNITS, x, y);
@@ -42,7 +42,7 @@ public final class PhysicalScale {
*
* @param x horizontal units per pixel in radians.
* @param y vertical units per pixel in radians.
- * @return the physical scale.
+ * @return The physical scale.
*/
public static PhysicalScale createFromRadians(final double x, final double y) {
return new PhysicalScale(RADIAN_UNITS, x, y);
@@ -63,7 +63,7 @@ public final class PhysicalScale {
/**
* Gets the horizontal units per pixel.
*
- * @return the horizontal units per pixel.
+ * @return The horizontal units per pixel.
*/
public double getHorizontalUnitsPerPixel() {
return horizontalUnitsPerPixel;
@@ -72,7 +72,7 @@ public final class PhysicalScale {
/**
* Gets the vertical units per pixel.
*
- * @return the vertical units per pixel.
+ * @return The vertical units per pixel.
*/
public double getVerticalUnitsPerPixel() {
return verticalUnitsPerPixel;
diff --git a/src/main/java/org/apache/commons/imaging/formats/png/PngColorType.java b/src/main/java/org/apache/commons/imaging/formats/png/PngColorType.java
index 5cdb0040..d4dd1ab9 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/PngColorType.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/PngColorType.java
@@ -58,7 +58,7 @@ public enum PngColorType {
* Gets the color type corresponding to the given value.
*
* @param value the color type value.
- * @return the color type, or null if not found.
+ * @return The color type, or null if not found.
*/
public static PngColorType getColorType(final int value) {
for (final PngColorType type : values()) {
diff --git a/src/main/java/org/apache/commons/imaging/formats/png/PngImageParser.java b/src/main/java/org/apache/commons/imaging/formats/png/PngImageParser.java
index 90fba9ce..0b4cec67 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/PngImageParser.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/PngImageParser.java
@@ -82,7 +82,7 @@ public class PngImageParser extends AbstractImageParser<PngImagingParameters> im
* Gets the chunk type name from chunk type integer.
*
* @param chunkType the chunk type.
- * @return the chunk type name as a string.
+ * @return The chunk type name as a string.
*/
public static String getChunkTypeName(final int chunkType) {
final StringBuilder result = new StringBuilder();
diff --git a/src/main/java/org/apache/commons/imaging/formats/png/PngImagingParameters.java b/src/main/java/org/apache/commons/imaging/formats/png/PngImagingParameters.java
index af6d4b3a..eec84610 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/PngImagingParameters.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/PngImagingParameters.java
@@ -73,7 +73,7 @@ public class PngImagingParameters extends XmpImagingParameters<PngImagingParamet
/**
* Gets the bit depth.
*
- * @return the bit depth.
+ * @return The bit depth.
*/
public byte getBitDepth() {
return bitDepth;
@@ -82,7 +82,7 @@ public class PngImagingParameters extends XmpImagingParameters<PngImagingParamet
/**
* Gets the physical scale.
*
- * @return the physical scale.
+ * @return The physical scale.
*/
public PhysicalScale getPhysicalScale() {
return physicalScale;
@@ -91,7 +91,7 @@ public class PngImagingParameters extends XmpImagingParameters<PngImagingParamet
/**
* Gets the text chunks.
*
- * @return the text chunks.
+ * @return The text chunks.
*/
public List<? extends AbstractPngText> getTextChunks() {
return textChunks != null ? Collections.unmodifiableList(textChunks) : null;
diff --git a/src/main/java/org/apache/commons/imaging/formats/png/chunks/AbstractPngTextChunk.java b/src/main/java/org/apache/commons/imaging/formats/png/chunks/AbstractPngTextChunk.java
index 870279bc..6e9ab18e 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/chunks/AbstractPngTextChunk.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/chunks/AbstractPngTextChunk.java
@@ -38,21 +38,21 @@ public abstract class AbstractPngTextChunk extends PngChunk {
/**
* Gets the text contents of this chunk.
*
- * @return the text contents.
+ * @return The text contents.
*/
public abstract AbstractPngText getContents();
/**
* Gets the keyword of this text chunk.
*
- * @return the keyword.
+ * @return The keyword.
*/
public abstract String getKeyword();
/**
* Gets the text value of this text chunk.
*
- * @return the text.
+ * @return The text.
*/
public abstract String getText();
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 981f54a0..e6bf3203 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
@@ -72,7 +72,7 @@ public class PngChunk extends BinaryFileParser {
/**
* Gets a copy of the chunk bytes.
*
- * @return the chunk bytes
+ * @return The chunk bytes
*/
public byte[] getBytes() {
return bytes.clone();
@@ -81,7 +81,7 @@ public class PngChunk extends BinaryFileParser {
/**
* Gets the chunk type.
*
- * @return the chunk type.
+ * @return The chunk type.
*/
public int getChunkType() {
return chunkType;
@@ -90,7 +90,7 @@ public class PngChunk extends BinaryFileParser {
/**
* Gets the CRC value.
*
- * @return the CRC.
+ * @return The CRC.
*/
public int getCrc() {
return crc;
@@ -112,7 +112,7 @@ public class PngChunk extends BinaryFileParser {
/**
* Gets the chunk length.
*
- * @return the length.
+ * @return The length.
*/
public int getLength() {
return length;
@@ -121,7 +121,7 @@ public class PngChunk extends BinaryFileParser {
/**
* Gets a copy of the chunk property bits.
*
- * @return the chunk property bits
+ * @return The chunk property bits
*/
public boolean[] getPropertyBits() {
return propertyBits.clone();
diff --git a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkGama.java b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkGama.java
index b9cbcbf8..50211f8f 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkGama.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkGama.java
@@ -47,7 +47,7 @@ public final class PngChunkGama extends PngChunk {
/**
* Gets the gamma value.
*
- * @return the gamma value.
+ * @return The gamma value.
*/
public double getGamma() {
return 1.0 / (gamma / 100000.0);
diff --git a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkIccp.java b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkIccp.java
index cb483d86..be1d9bd1 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkIccp.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkIccp.java
@@ -103,7 +103,7 @@ public final class PngChunkIccp extends PngChunk {
/**
* Gets a copy of the compressed profile data.
*
- * @return the compressed profile data.
+ * @return The compressed profile data.
*/
public byte[] getCompressedProfile() {
return compressedProfile.clone();
@@ -112,7 +112,7 @@ public final class PngChunkIccp extends PngChunk {
/**
* Gets the compression method.
*
- * @return the compression method.
+ * @return The compression method.
*/
public int getCompressionMethod() {
return compressionMethod;
@@ -121,7 +121,7 @@ public final class PngChunkIccp extends PngChunk {
/**
* Gets the profile name.
*
- * @return the profile name.
+ * @return The profile name.
*/
public String getProfileName() {
return profileName;
@@ -130,7 +130,7 @@ public final class PngChunkIccp extends PngChunk {
/**
* Gets a copy of the uncompressed profile data.
*
- * @return the uncompressed profile data
+ * @return The uncompressed profile data
*/
public byte[] getUncompressedProfile() {
return uncompressedProfile.clone();
diff --git a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkIhdr.java b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkIhdr.java
index 1e85de2b..bf4a772e 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkIhdr.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkIhdr.java
@@ -73,7 +73,7 @@ public final class PngChunkIhdr extends PngChunk {
/**
* Gets the bit depth.
*
- * @return the bit depth.
+ * @return The bit depth.
*/
public int getBitDepth() {
return bitDepth;
@@ -82,7 +82,7 @@ public final class PngChunkIhdr extends PngChunk {
/**
* Gets the compression method.
*
- * @return the compression method.
+ * @return The compression method.
*/
public int getCompressionMethod() {
return compressionMethod;
@@ -91,7 +91,7 @@ public final class PngChunkIhdr extends PngChunk {
/**
* Gets the filter method.
*
- * @return the filter method.
+ * @return The filter method.
*/
public int getFilterMethod() {
return filterMethod;
@@ -100,7 +100,7 @@ public final class PngChunkIhdr extends PngChunk {
/**
* Gets the image height.
*
- * @return the height.
+ * @return The height.
*/
public int getHeight() {
return height;
@@ -109,7 +109,7 @@ public final class PngChunkIhdr extends PngChunk {
/**
* Gets the interlace method.
*
- * @return the interlace method.
+ * @return The interlace method.
*/
public InterlaceMethod getInterlaceMethod() {
return interlaceMethod;
@@ -118,7 +118,7 @@ public final class PngChunkIhdr extends PngChunk {
/**
* Gets the PNG color type.
*
- * @return the PNG color type.
+ * @return The PNG color type.
*/
public PngColorType getPngColorType() {
return pngColorType;
@@ -127,7 +127,7 @@ public final class PngChunkIhdr extends PngChunk {
/**
* Gets the image width.
*
- * @return the width.
+ * @return The width.
*/
public int getWidth() {
return width;
diff --git a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkItxt.java b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkItxt.java
index aedba79f..5ee40815 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkItxt.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkItxt.java
@@ -121,7 +121,7 @@ public final class PngChunkItxt extends AbstractPngTextChunk {
/**
* Gets the translated keyword.
*
- * @return the translated keyword.
+ * @return The translated keyword.
*/
public String getTranslatedKeyword() {
return translatedKeyword;
diff --git a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkPhys.java b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkPhys.java
index 810f3f6a..73f75c22 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkPhys.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkPhys.java
@@ -69,7 +69,7 @@ public final class PngChunkPhys extends PngChunk {
/**
* Gets the unit specifier (0 = unknown, 1 = meter).
*
- * @return the unit specifier.
+ * @return The unit specifier.
*/
public int getUnitSpecifier() {
return unitSpecifier;
diff --git a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkPlte.java b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkPlte.java
index 8312d74a..1971270d 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkPlte.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkPlte.java
@@ -75,7 +75,7 @@ public final class PngChunkPlte extends PngChunk {
/**
* Gets a copy of the RGB palette.
*
- * @return the RGB palette.
+ * @return The RGB palette.
*/
public int[] getRgb() {
return rgb.clone();
@@ -96,7 +96,7 @@ public final class PngChunkPlte extends PngChunk {
* Gets the RGB value at the specified palette index.
*
* @param index the palette index.
- * @return the RGB value.
+ * @return The RGB value.
* @throws ImagingException if the index is out of bounds.
*/
public int getRgb(final int index) throws ImagingException {
diff --git a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkScal.java b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkScal.java
index da7c2b59..a4bfbc74 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkScal.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkScal.java
@@ -64,7 +64,7 @@ public final class PngChunkScal extends PngChunk {
/**
* Gets the unit specifier (1 = meter, 2 = radian).
*
- * @return the unit specifier.
+ * @return The unit specifier.
*/
public int getUnitSpecifier() {
return unitSpecifier;
diff --git a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkText.java b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkText.java
index 813074bb..8d76dfd8 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkText.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkText.java
@@ -62,7 +62,7 @@ public final class PngChunkText extends AbstractPngTextChunk {
}
/**
- * @return the keyword.
+ * @return The keyword.
*/
@Override
public String getKeyword() {
@@ -70,7 +70,7 @@ public final class PngChunkText extends AbstractPngTextChunk {
}
/**
- * @return the text.
+ * @return The text.
*/
@Override
public String getText() {
diff --git a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkZtxt.java b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkZtxt.java
index 15dfd2a8..af8763d0 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkZtxt.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/chunks/PngChunkZtxt.java
@@ -73,7 +73,7 @@ public final class PngChunkZtxt extends AbstractPngTextChunk {
/**
* Gets the keyword.
*
- * @return the keyword.
+ * @return The keyword.
*/
@Override
public String getKeyword() {
@@ -83,7 +83,7 @@ public final class PngChunkZtxt extends AbstractPngTextChunk {
/**
* Gets the text.
*
- * @return the text.
+ * @return The text.
*/
@Override
public String getText() {
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 38f444a1..8dfbe2b4 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
@@ -42,7 +42,7 @@ public abstract class AbstractTransparencyFilter extends BinaryFileParser {
*
* @param rgb the RGB value.
* @param index the pixel index.
- * @return the filtered RGB value.
+ * @return The filtered RGB value.
* @throws ImagingException if the image format is invalid.
* @throws IOException if an I/O error occurs.
*/
@@ -61,7 +61,7 @@ public abstract class AbstractTransparencyFilter extends BinaryFileParser {
/**
* Gets the length.
*
- * @return the length
+ * @return The length
*/
public int getLength() {
return bytes.length;
diff --git a/src/main/java/org/apache/commons/imaging/formats/pnm/PnmImagingParameters.java b/src/main/java/org/apache/commons/imaging/formats/pnm/PnmImagingParameters.java
index b1fc4653..251b237e 100644
--- a/src/main/java/org/apache/commons/imaging/formats/pnm/PnmImagingParameters.java
+++ b/src/main/java/org/apache/commons/imaging/formats/pnm/PnmImagingParameters.java
@@ -43,7 +43,7 @@ public class PnmImagingParameters extends ImagingParameters<PnmImagingParameters
/**
* Gets the subtype.
*
- * @return the subtype.
+ * @return The subtype.
*/
public ImageFormats getSubtype() {
return subtype;
diff --git a/src/main/java/org/apache/commons/imaging/formats/psd/PsdHeaderInfo.java b/src/main/java/org/apache/commons/imaging/formats/psd/PsdHeaderInfo.java
index 34fa258f..80dede2b 100644
--- a/src/main/java/org/apache/commons/imaging/formats/psd/PsdHeaderInfo.java
+++ b/src/main/java/org/apache/commons/imaging/formats/psd/PsdHeaderInfo.java
@@ -108,7 +108,7 @@ public class PsdHeaderInfo {
/**
* Gets a copy of the reserved bytes.
*
- * @return the reserved bytes.
+ * @return The reserved bytes.
*/
public byte[] getReserved() {
return reserved.clone();
diff --git a/src/main/java/org/apache/commons/imaging/formats/psd/dataparsers/AbstractDataParser.java b/src/main/java/org/apache/commons/imaging/formats/psd/dataparsers/AbstractDataParser.java
index 3c74732c..b438508b 100644
--- a/src/main/java/org/apache/commons/imaging/formats/psd/dataparsers/AbstractDataParser.java
+++ b/src/main/java/org/apache/commons/imaging/formats/psd/dataparsers/AbstractDataParser.java
@@ -37,7 +37,7 @@ public abstract class AbstractDataParser {
/**
* Gets the number of basic color channels.
*
- * @return the number of basic channels.
+ * @return The number of basic channels.
*/
public abstract int getBasicChannelsCount();
@@ -48,7 +48,7 @@ public abstract class AbstractDataParser {
* @param x the x coordinate.
* @param y the y coordinate.
* @param imageContents the image contents.
- * @return the RGB value.
+ * @return The RGB value.
*/
protected abstract int getRgb(int[][][] data, int x, int y, PsdImageContents imageContents);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffElement.java b/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffElement.java
index a7d9a2c1..bded1338 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffElement.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffElement.java
@@ -45,7 +45,7 @@ public abstract class AbstractTiffElement {
/**
* Gets a copy of the element data.
*
- * @return the data.
+ * @return The data.
*/
public byte[] getData() {
return data.clone();
@@ -54,7 +54,7 @@ public abstract class AbstractTiffElement {
/**
* Gets the length of the data.
*
- * @return the data length.
+ * @return The data length.
*/
public int getDataLength() {
return data.length;
@@ -106,7 +106,7 @@ public abstract class AbstractTiffElement {
/**
* Gets a description of this element.
*
- * @return the element description.
+ * @return The element description.
*/
public abstract String getElementDescription();
}
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 beb0767c..fdc1cd80 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
@@ -95,7 +95,7 @@ public abstract class AbstractTiffImageData {
* Gets the image data at the specified offset.
*
* @param offset the offset index.
- * @return the data element.
+ * @return The data element.
*/
public AbstractTiffElement.DataElement getImageData(final int offset) {
return strips[offset];
@@ -104,7 +104,7 @@ public abstract class AbstractTiffImageData {
/**
* Gets the number of strips in the image.
*
- * @return the number of strips.
+ * @return The number of strips.
*/
public int getImageDataLength() {
return strips.length;
@@ -216,7 +216,7 @@ public abstract class AbstractTiffImageData {
* @param compression the compression type.
* @param planarConfiguration the planar configuration.
* @param byteOrder the byte order.
- * @return the data reader.
+ * @return The data reader.
* @throws IOException if an I/O error occurs.
* @throws ImagingException if the image format is invalid.
*/
@@ -227,7 +227,7 @@ public abstract class AbstractTiffImageData {
/**
* Gets the image data elements.
*
- * @return the array of data elements.
+ * @return The array of data elements.
*/
public abstract AbstractTiffElement.DataElement[] getImageData();
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 3cb9bc2d..05ebcd6b 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
@@ -76,7 +76,7 @@ public abstract class AbstractTiffRasterData {
* @param x the x coordinate.
* @param y the y coordinate.
* @param i the sample index.
- * @return the computed array index.
+ * @return The computed array index.
* @throws IllegalArgumentException if coordinates or sample index are out of range.
*/
protected final int checkCoordinatesAndComputeIndex(final int x, final int y, final int i) {
@@ -98,7 +98,7 @@ public abstract class AbstractTiffRasterData {
* <p>
* See the class API documentation above for notes on accessing array elements.
*
- * @return the data content stored in this instance.
+ * @return The data content stored in this instance.
*/
public abstract float[] getData();
@@ -112,7 +112,7 @@ public abstract class AbstractTiffRasterData {
/**
* Gets the height (number of rows) of the raster.
*
- * @return the height of the raster.
+ * @return The height of the raster.
*/
public final int getHeight() {
return height;
@@ -127,7 +127,7 @@ public abstract class AbstractTiffRasterData {
* <p>
* See the class API documentation above for notes on accessing array elements.
*
- * @return the data content stored in this instance.
+ * @return The data content stored in this instance.
*/
public abstract int[] getIntData();
@@ -136,7 +136,7 @@ public abstract class AbstractTiffRasterData {
*
* @param x integer coordinate in the columnar direction.
* @param y integer coordinate in the row direction.
- * @return the value stored at the specified location.
+ * @return The value stored at the specified location.
*/
public abstract int getIntValue(int x, int y);
@@ -146,7 +146,7 @@ public abstract class AbstractTiffRasterData {
* @param x integer coordinate in the columnar direction.
* @param y integer coordinate in the row direction.
* @param i integer sample index (for data sets giving multiple samples per raster cell).
- * @return the value stored at the specified location.
+ * @return The value stored at the specified location.
*/
public abstract int getIntValue(int x, int y, int i);
@@ -179,7 +179,7 @@ public abstract class AbstractTiffRasterData {
*
* @param x integer coordinate in the columnar direction.
* @param y integer coordinate in the row direction.
- * @return the value stored at the specified location; potentially a Float.NaN.
+ * @return The value stored at the specified location; potentially a Float.NaN.
*/
public abstract float getValue(int x, int y);
@@ -189,14 +189,14 @@ public abstract class AbstractTiffRasterData {
* @param x integer coordinate in the columnar direction.
* @param y integer coordinate in the row direction.
* @param i integer sample index.
- * @return the value stored at the specified location; potentially a Float.NaN.
+ * @return The value stored at the specified location; potentially a Float.NaN.
*/
public abstract float getValue(int x, int y, int i);
/**
* Gets the width (number of columns) of the raster.
*
- * @return the width of the raster
+ * @return The width of the raster
*/
public final int getWidth() {
return width;
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffContents.java b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffContents.java
index 72949187..241bd945 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffContents.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffContents.java
@@ -93,7 +93,7 @@ public class TiffContents {
* Finds a field by tag.
*
* @param tag the tag to search for.
- * @return the field, or null if not found.
+ * @return The field, or null if not found.
* @throws ImagingException if an error occurs during search.
*/
public TiffField findField(final TagInfo tag) throws ImagingException {
@@ -110,7 +110,7 @@ public class TiffContents {
/**
* Gets all TIFF elements including header, directories, and field data.
*
- * @return the list of elements.
+ * @return The list of elements.
* @throws ImagingException if an error occurs.
*/
public List<AbstractTiffElement> getElements() throws ImagingException {
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 24449b56..153f6038 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
@@ -89,7 +89,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
* Gets a description for a directory type.
*
* @param type the directory type.
- * @return the description.
+ * @return The description.
*/
public static String description(final int type) {
switch (type) {
@@ -162,7 +162,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
/**
* Gets a description of this directory's type.
*
- * @return the description.
+ * @return The description.
*/
public String description() {
return description(type);
@@ -179,7 +179,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
* Finds a field by tag.
*
* @param tag the tag to search for.
- * @return the field, or null if not found.
+ * @return The field, or null if not found.
* @throws ImagingException if an error occurs.
*/
public TiffField findField(final TagInfo tag) throws ImagingException {
@@ -192,7 +192,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param tag the tag to search for.
* @param failIfMissing whether to throw an exception if not found.
- * @return the field, or null if not found.
+ * @return The field, or null if not found.
* @throws ImagingException if an error occurs or field is missing and failIfMissing is true.
*/
public TiffField findField(final TagInfo tag, final boolean failIfMissing) throws ImagingException {
@@ -221,7 +221,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
/**
* Gets a copy of all directory entries.
*
- * @return the list of fields.
+ * @return The list of fields.
*/
public List<TiffField> getDirectoryEntries() {
return new ArrayList<>(entries);
@@ -245,7 +245,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
* Gets the value of a field.
*
* @param tag the tag.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs.
*/
public Object getFieldValue(final TagInfo tag) throws ImagingException {
@@ -261,7 +261,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param tag the tag.
* @param mustExist whether the field must exist.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs or field is missing and mustExist is true.
*/
public String[] getFieldValue(final TagInfoAscii tag, final boolean mustExist) throws ImagingException {
@@ -286,7 +286,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
* Gets the value of a byte field.
*
* @param tag the tag.
- * @return the field value.
+ * @return The field value.
* @throws ImagingException if an error occurs or field is missing.
*/
public byte getFieldValue(final TagInfoByte tag) throws ImagingException {
@@ -308,7 +308,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param tag the tag.
* @param mustExist whether the field must exist.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs or field is missing and mustExist is true.
*/
public byte[] getFieldValue(final TagInfoBytes tag, final boolean mustExist) throws ImagingException {
@@ -332,7 +332,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
* Gets the value of a double field.
*
* @param tag the tag.
- * @return the field value.
+ * @return The field value.
* @throws ImagingException if an error occurs or field is missing.
*/
public double getFieldValue(final TagInfoDouble tag) throws ImagingException {
@@ -355,7 +355,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param tag the tag.
* @param mustExist whether the field must exist.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs or field is missing and mustExist is true.
*/
public double[] getFieldValue(final TagInfoDoubles tag, final boolean mustExist) throws ImagingException {
@@ -380,7 +380,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
* Gets the value of a float field.
*
* @param tag the tag.
- * @return the field value.
+ * @return The field value.
* @throws ImagingException if an error occurs or field is missing.
*/
public float getFieldValue(final TagInfoFloat tag) throws ImagingException {
@@ -403,7 +403,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param tag the tag.
* @param mustExist whether the field must exist.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs or field is missing and mustExist is true.
*/
public float[] getFieldValue(final TagInfoFloats tag, final boolean mustExist) throws ImagingException {
@@ -429,7 +429,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param tag the tag.
* @param mustExist whether the field must exist.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs or field is missing and mustExist is true.
*/
public String getFieldValue(final TagInfoGpsText tag, final boolean mustExist) throws ImagingException {
@@ -453,7 +453,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
* Gets the value of a long field.
*
* @param tag the tag.
- * @return the field value.
+ * @return The field value.
* @throws ImagingException if an error occurs or field is missing.
*/
public int getFieldValue(final TagInfoLong tag) throws ImagingException {
@@ -476,7 +476,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param tag the tag.
* @param mustExist whether the field must exist.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs or field is missing and mustExist is true.
*/
public int[] getFieldValue(final TagInfoLongs tag, final boolean mustExist) throws ImagingException {
@@ -501,7 +501,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
* Gets the value of a rational field.
*
* @param tag the tag.
- * @return the field value.
+ * @return The field value.
* @throws ImagingException if an error occurs or field is missing.
*/
public RationalNumber getFieldValue(final TagInfoRational tag) throws ImagingException {
@@ -524,7 +524,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param tag the tag.
* @param mustExist whether the field must exist.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs or field is missing and mustExist is true.
*/
public RationalNumber[] getFieldValue(final TagInfoRationals tag, final boolean mustExist) throws ImagingException {
@@ -549,7 +549,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
* Gets the value of a signed byte field.
*
* @param tag the tag.
- * @return the field value.
+ * @return The field value.
* @throws ImagingException if an error occurs or field is missing.
*/
public byte getFieldValue(final TagInfoSByte tag) throws ImagingException {
@@ -571,7 +571,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param tag the tag.
* @param mustExist whether the field must exist.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs or field is missing and mustExist is true.
*/
public byte[] getFieldValue(final TagInfoSBytes tag, final boolean mustExist) throws ImagingException {
@@ -595,7 +595,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
* Gets the value of a short field.
*
* @param tag the tag.
- * @return the field value.
+ * @return The field value.
* @throws ImagingException if an error occurs or field is missing.
*/
public short getFieldValue(final TagInfoShort tag) throws ImagingException {
@@ -618,7 +618,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param tag the tag.
* @param mustExist whether the field must exist.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs or field is missing and mustExist is true.
*/
public int[] getFieldValue(final TagInfoShortOrLong tag, final boolean mustExist) throws ImagingException {
@@ -647,7 +647,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param tag the tag.
* @param mustExist whether the field must exist.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs or field is missing and mustExist is true.
*/
public short[] getFieldValue(final TagInfoShorts tag, final boolean mustExist) throws ImagingException {
@@ -672,7 +672,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
* Gets the value of a signed long field.
*
* @param tag the tag.
- * @return the field value.
+ * @return The field value.
* @throws ImagingException if an error occurs or field is missing.
*/
public int getFieldValue(final TagInfoSLong tag) throws ImagingException {
@@ -695,7 +695,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param tag the tag.
* @param mustExist whether the field must exist.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs or field is missing and mustExist is true.
*/
public int[] getFieldValue(final TagInfoSLongs tag, final boolean mustExist) throws ImagingException {
@@ -720,7 +720,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
* Gets the value of a signed rational field.
*
* @param tag the tag.
- * @return the field value.
+ * @return The field value.
* @throws ImagingException if an error occurs or field is missing.
*/
public RationalNumber getFieldValue(final TagInfoSRational tag) throws ImagingException {
@@ -743,7 +743,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param tag the tag.
* @param mustExist whether the field must exist.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs or field is missing and mustExist is true.
*/
public RationalNumber[] getFieldValue(final TagInfoSRationals tag, final boolean mustExist) throws ImagingException {
@@ -768,7 +768,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
* Gets the value of a signed short field.
*
* @param tag the tag.
- * @return the field value.
+ * @return The field value.
* @throws ImagingException if an error occurs or field is missing.
*/
public short getFieldValue(final TagInfoSShort tag) throws ImagingException {
@@ -791,7 +791,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param tag the tag.
* @param mustExist whether the field must exist.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs or field is missing and mustExist is true.
*/
public short[] getFieldValue(final TagInfoSShorts tag, final boolean mustExist) throws ImagingException {
@@ -817,7 +817,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param tag the tag.
* @param mustExist whether the field must exist.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs or field is missing and mustExist is true.
*/
public String getFieldValue(final TagInfoXpString tag, final boolean mustExist) throws ImagingException {
@@ -840,7 +840,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
/**
* Gets the JPEG image data.
*
- * @return the JPEG image data, or null if not available.
+ * @return The JPEG image data, or null if not available.
*/
public JpegImageData getJpegImageData() {
return jpegImageData;
@@ -849,7 +849,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
/**
* Gets the JPEG raw image data element.
*
- * @return the image data element.
+ * @return The image data element.
* @throws ImagingException if an error occurs.
*/
public ImageDataElement getJpegRawImageDataElement() throws ImagingException {
@@ -868,7 +868,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
/**
* Gets the offset to the next directory.
*
- * @return the next directory offset.
+ * @return The next directory offset.
*/
public long getNextDirectoryOffset() {
return nextDirectoryOffset;
@@ -917,7 +917,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
*
* @param offsetsField the offsets field.
* @param byteCountsField the byte counts field.
- * @return the list of image data elements.
+ * @return The list of image data elements.
* @throws ImagingException if an error occurs.
*/
private List<ImageDataElement> getRawImageDataElements(final TiffField offsetsField, final TiffField byteCountsField) throws ImagingException {
@@ -939,7 +939,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
* Gets a single ASCII field value.
*
* @param tag the tag.
- * @return the field value.
+ * @return The field value.
* @throws ImagingException if an error occurs or field is missing.
*/
public String getSingleFieldValue(final TagInfoAscii tag) throws ImagingException {
@@ -954,7 +954,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
* Gets a single short or long field value.
*
* @param tag the tag.
- * @return the field value.
+ * @return The field value.
* @throws ImagingException if an error occurs or field is missing.
*/
public int getSingleFieldValue(final TagInfoShortOrLong tag) throws ImagingException {
@@ -1037,7 +1037,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
/**
* Gets the TIFF image data.
*
- * @return the TIFF image data, or null if not available.
+ * @return The TIFF image data, or null if not available.
*/
public AbstractTiffImageData getTiffImageData() {
return abstractTiffImageData;
@@ -1046,7 +1046,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
/**
* Gets the raw TIFF image data elements.
*
- * @return the list of image data elements.
+ * @return The list of image data elements.
* @throws ImagingException if an error occurs.
*/
public List<ImageDataElement> getTiffRawImageDataElements() throws ImagingException {
@@ -1165,7 +1165,7 @@ public class TiffDirectory extends AbstractTiffElement implements Iterable<TiffF
/**
* Gets the number of fields in this directory.
*
- * @return the number of fields.
+ * @return The number of fields.
*/
public int size() {
return entries.size();
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 6456b946..6c1006dd 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
@@ -143,7 +143,7 @@ public class TiffField {
/**
* Gets a copy of the raw value of the field.
*
- * @return the value of the field, in the byte order of the field.
+ * @return The value of the field, in the byte order of the field.
*/
public byte[] getByteArrayValue() {
return BinaryFunctions.copyOfStart(value, getBytesLength());
@@ -152,7 +152,7 @@ public class TiffField {
/**
* Gets the field's byte order.
*
- * @return the byte order
+ * @return The byte order
*/
public ByteOrder getByteOrder() {
return byteOrder;
@@ -161,7 +161,7 @@ public class TiffField {
/**
* Gets the length of the field's value.
*
- * @return the length, in bytes.
+ * @return The length, in bytes.
*/
public int getBytesLength() {
return (int) count * abstractFieldType.getSize();
@@ -170,7 +170,7 @@ public class TiffField {
/**
* Gets the field's count, derived from bytes 4-7.
*
- * @return the count
+ * @return The count
*/
public long getCount() {
return count;
@@ -179,7 +179,7 @@ public class TiffField {
/**
* Gets a description of this field without the value.
*
- * @return the description.
+ * @return The description.
*/
public String getDescriptionWithoutValue() {
return getTag() + " (0x" + Integer.toHexString(getTag()) + ": " + getTagInfo().name + "): ";
@@ -188,7 +188,7 @@ public class TiffField {
/**
* Gets the directory type.
*
- * @return the directory type.
+ * @return The directory type.
*/
public int getDirectoryType() {
return directoryType;
@@ -197,7 +197,7 @@ public class TiffField {
/**
* Gets the field value as a double array.
*
- * @return the double array value.
+ * @return The double array value.
* @throws ImagingException if the value cannot be converted.
*/
public double[] getDoubleArrayValue() throws ImagingException {
@@ -244,7 +244,7 @@ public class TiffField {
/**
* Gets the field value as a single double.
*
- * @return the double value.
+ * @return The double value.
* @throws ImagingException if the value is missing or cannot be converted.
*/
public double getDoubleValue() throws ImagingException {
@@ -259,7 +259,7 @@ public class TiffField {
/**
* Gets the field's type, derived from bytes 2-3.
*
- * @return the field's type, as a {@code FieldType} object.
+ * @return The field's type, as a {@code FieldType} object.
*/
public AbstractFieldType getFieldType() {
return abstractFieldType;
@@ -268,7 +268,7 @@ public class TiffField {
/**
* Gets the field type name.
*
- * @return the field type name.
+ * @return The field type name.
*/
public String getFieldTypeName() {
return getFieldType().getName();
@@ -277,7 +277,7 @@ public class TiffField {
/**
* Gets the field value as an int array.
*
- * @return the int array value.
+ * @return The int array value.
* @throws ImagingException if the value cannot be converted.
*/
public int[] getIntArrayValue() throws ImagingException {
@@ -320,7 +320,7 @@ public class TiffField {
/**
* Gets the field value as a single int.
*
- * @return the int value.
+ * @return The int value.
* @throws ImagingException if the value is missing or cannot be converted.
*/
public int getIntValue() throws ImagingException {
@@ -335,7 +335,7 @@ public class TiffField {
/**
* Gets the int value or sum of array values.
*
- * @return the int value or sum.
+ * @return The int value or sum.
* @throws ImagingException if an error occurs.
*/
public int getIntValueOrArraySum() throws ImagingException {
@@ -429,7 +429,7 @@ public class TiffField {
/**
* Gets the TIFF field's offset/value field, derived from bytes 8-11.
*
- * @return the field's offset in a {@code long} of 4 packed bytes, or its inlined value <= 4 bytes long encoded in the field's byte order.
+ * @return The field's offset in a {@code long} of 4 packed bytes, or its inlined value <= 4 bytes long encoded in the field's byte order.
*/
public long getOffset() {
return (int) offset;
@@ -438,7 +438,7 @@ public class TiffField {
/**
* Gets the oversized value element if this field has one.
*
- * @return the oversized value element, or null.
+ * @return The oversized value element, or null.
*/
public AbstractTiffElement getOversizeValueElement() {
if (isLocalValue()) {
@@ -451,7 +451,7 @@ public class TiffField {
/**
* Gets the sort hint for ordering fields.
*
- * @return the sort hint.
+ * @return The sort hint.
*/
public int getSortHint() {
return sortHint;
@@ -460,7 +460,7 @@ public class TiffField {
/**
* Gets the field's string value.
*
- * @return the string value.
+ * @return The string value.
* @throws ImagingException if an error occurs.
*/
public String getStringValue() throws ImagingException {
@@ -477,7 +477,7 @@ public class TiffField {
/**
* Gets the field's tag, derived from bytes 0-1.
*
- * @return the tag, as an {@code int} in which only the lowest 2 bytes are set.
+ * @return The tag, as an {@code int} in which only the lowest 2 bytes are set.
*/
public int getTag() {
return tag;
@@ -486,7 +486,7 @@ public class TiffField {
/**
* Gets tag information.
*
- * @return the tag info.
+ * @return The tag info.
*/
public TagInfo getTagInfo() {
return tagInfo;
@@ -495,7 +495,7 @@ public class TiffField {
/**
* Gets the tag name.
*
- * @return the tag name.
+ * @return The tag name.
*/
public String getTagName() {
if (getTagInfo() == TiffTagConstants.TIFF_TAG_UNKNOWN) {
@@ -507,7 +507,7 @@ public class TiffField {
/**
* Gets the value of the field.
*
- * @return the value of the field.
+ * @return The value of the field.
* @throws ImagingException if an error occurs.
*/
public Object getValue() throws ImagingException {
@@ -518,7 +518,7 @@ public class TiffField {
/**
* Gets a description of the field's value.
*
- * @return the value description.
+ * @return The value description.
*/
public String getValueDescription() {
try {
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImageMetadata.java b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImageMetadata.java
index a92f0ee6..03a0f8da 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImageMetadata.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImageMetadata.java
@@ -91,7 +91,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Finds a field by tag.
*
* @param tagInfo the tag information.
- * @return the field, or null if not found.
+ * @return The field, or null if not found.
* @throws ImagingException if an error occurs.
*/
public TiffField findField(final TagInfo tagInfo) throws ImagingException {
@@ -101,7 +101,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
/**
* Gets all fields in this directory.
*
- * @return the list of fields.
+ * @return The list of fields.
*/
public List<TiffField> getAllFields() {
return directory.getDirectoryEntries();
@@ -110,7 +110,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
/**
* Gets JPEG image data if present.
*
- * @return the JPEG image data, or null.
+ * @return The JPEG image data, or null.
*/
public JpegImageData getJpegImageData() {
return directory.getJpegImageData();
@@ -120,7 +120,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Gets the output directory for writing.
*
* @param byteOrder the byte order to use.
- * @return the output directory.
+ * @return The output directory.
* @throws ImagingException if an error occurs.
*/
public TiffOutputDirectory getOutputDirectory(final ByteOrder byteOrder) throws ImagingException {
@@ -177,7 +177,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
/**
* Gets the thumbnail image.
*
- * @return the thumbnail image.
+ * @return The thumbnail image.
* @throws ImagingException if an imaging error occurs.
* @throws IOException if an I/O error occurs.
*/
@@ -188,7 +188,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
/**
* Gets the TIFF image data.
*
- * @return the TIFF image data.
+ * @return The TIFF image data.
*/
public AbstractTiffImageData getTiffImageData() {
return directory.getTiffImageData();
@@ -277,7 +277,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
/**
* Gets the latitude as degrees north.
*
- * @return the latitude in degrees north (negative for south).
+ * @return The latitude in degrees north (negative for south).
* @throws ImagingException if the latitude reference is invalid.
*/
public double getLatitudeAsDegreesNorth() throws ImagingException {
@@ -295,7 +295,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
/**
* Gets the longitude as degrees east.
*
- * @return the longitude in degrees east (negative for west).
+ * @return The longitude in degrees east (negative for west).
* @throws ImagingException if the longitude reference is invalid.
*/
public double getLongitudeAsDegreesEast() throws ImagingException {
@@ -344,7 +344,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
/**
* Gets the TIFF field.
*
- * @return the TIFF field.
+ * @return The TIFF field.
*/
public TiffField getTiffField() {
return entry;
@@ -370,7 +370,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Finds a directory by type.
*
* @param directoryType the directory type.
- * @return the directory, or null if not found.
+ * @return The directory, or null if not found.
*/
public TiffDirectory findDirectory(final int directoryType) {
final List<? extends ImageMetadataItem> directories = getDirectories();
@@ -387,7 +387,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Finds a field by tag.
*
* @param tagInfo the tag information.
- * @return the field, or null if not found.
+ * @return The field, or null if not found.
* @throws ImagingException if an error occurs.
*/
public TiffField findField(final TagInfo tagInfo) throws ImagingException {
@@ -399,7 +399,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
*
* @param tagInfo the tag information.
* @param exactDirectoryMatch whether to require exact directory match.
- * @return the field, or null if not found.
+ * @return The field, or null if not found.
* @throws ImagingException if an error occurs.
*/
public TiffField findField(final TagInfo tagInfo, final boolean exactDirectoryMatch) throws ImagingException {
@@ -446,7 +446,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
/**
* Gets all fields from all directories.
*
- * @return the list of all fields.
+ * @return The list of all fields.
*/
public List<TiffField> getAllFields() {
final List<TiffField> result = new ArrayList<>();
@@ -461,7 +461,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
/**
* Gets all directories.
*
- * @return the list of directories.
+ * @return The list of directories.
*/
public List<? extends ImageMetadataItem> getDirectories() {
return super.getItems();
@@ -471,7 +471,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Gets the value of a field.
*
* @param tag the tag.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs.
*/
public Object getFieldValue(final TagInfo tag) throws ImagingException {
@@ -486,7 +486,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Gets the value of an ASCII field.
*
* @param tag the tag.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs.
*/
public String[] getFieldValue(final TagInfoAscii tag) throws ImagingException {
@@ -505,7 +505,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Gets the value of a byte field.
*
* @param tag the tag.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs.
*/
public byte[] getFieldValue(final TagInfoByte tag) throws ImagingException {
@@ -523,7 +523,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Gets the value of a doubles field.
*
* @param tag the tag.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs.
*/
public double[] getFieldValue(final TagInfoDoubles tag) throws ImagingException {
@@ -542,7 +542,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Gets the value of a floats field.
*
* @param tag the tag.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs.
*/
public float[] getFieldValue(final TagInfoFloats tag) throws ImagingException {
@@ -561,7 +561,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Gets the value of a GPS text field.
*
* @param tag the tag.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs.
*/
public String getFieldValue(final TagInfoGpsText tag) throws ImagingException {
@@ -576,7 +576,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Gets the value of a longs field.
*
* @param tag the tag.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs.
*/
public int[] getFieldValue(final TagInfoLongs tag) throws ImagingException {
@@ -595,7 +595,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Gets the value of a rationals field.
*
* @param tag the tag.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs.
*/
public RationalNumber[] getFieldValue(final TagInfoRationals tag) throws ImagingException {
@@ -614,7 +614,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Gets the value of a signed bytes field.
*
* @param tag the tag.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs.
*/
public byte[] getFieldValue(final TagInfoSBytes tag) throws ImagingException {
@@ -632,7 +632,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Gets the value of a shorts field.
*
* @param tag the tag.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs.
*/
public short[] getFieldValue(final TagInfoShorts tag) throws ImagingException {
@@ -651,7 +651,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Gets the value of a signed longs field.
*
* @param tag the tag.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs.
*/
public int[] getFieldValue(final TagInfoSLongs tag) throws ImagingException {
@@ -670,7 +670,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Gets the value of a signed rationals field.
*
* @param tag the tag.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs.
*/
public RationalNumber[] getFieldValue(final TagInfoSRationals tag) throws ImagingException {
@@ -689,7 +689,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Gets the value of a signed shorts field.
*
* @param tag the tag.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs.
*/
public short[] getFieldValue(final TagInfoSShorts tag) throws ImagingException {
@@ -708,7 +708,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
* Gets the value of an XP string field.
*
* @param tag the tag.
- * @return the field value, or null if not found.
+ * @return The field value, or null if not found.
* @throws ImagingException if an error occurs.
*/
public String getFieldValue(final TagInfoXpString tag) throws ImagingException {
@@ -722,7 +722,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
/**
* Gets GPS information from metadata.
*
- * @return the GPS info, or null if not available.
+ * @return The GPS info, or null if not available.
* @throws ImagingException if an error occurs.
*/
public GpsInfo getGpsInfo() throws ImagingException {
@@ -778,7 +778,7 @@ public class TiffImageMetadata extends GenericImageMetadata {
/**
* Gets an output set for writing.
*
- * @return the output set.
+ * @return The output set.
* @throws ImagingException if an error occurs.
*/
public TiffOutputSet getOutputSet() 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 bccb80a7..84fec928 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
@@ -92,7 +92,7 @@ public class TiffImageParser extends AbstractImageParser<TiffImagingParameters>
*
* @param byteSource the byte source.
* @param params the imaging parameters.
- * @return the list of raw image data.
+ * @return The list of raw image data.
* @throws ImagingException if an imaging error occurs.
* @throws IOException if an I/O error occurs.
*/
@@ -250,7 +250,7 @@ public class TiffImageParser extends AbstractImageParser<TiffImagingParameters>
* @param directory the TIFF directory.
* @param byteOrder the byte order.
* @param params the imaging parameters.
- * @return the buffered image.
+ * @return The buffered image.
* @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/formats/tiff/TiffImagingParameters.java b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImagingParameters.java
index 8d2227fe..cfeb2b33 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
@@ -118,7 +118,7 @@ public class TiffImagingParameters extends XmpImagingParameters<TiffImagingParam
/**
* Gets the compression algorithm.
*
- * @return the compression algorithm, or null if not set.
+ * @return The compression algorithm, or null if not set.
*/
public Integer getCompression() {
return compression;
@@ -127,7 +127,7 @@ public class TiffImagingParameters extends XmpImagingParameters<TiffImagingParam
/**
* Gets the custom photometric interpreter.
*
- * @return the custom photometric interpreter, or null if not set.
+ * @return The custom photometric interpreter, or null if not set.
*/
public AbstractPhotometricInterpreter getCustomPhotometricInterpreter() {
return customPhotometricInterpreter;
@@ -136,7 +136,7 @@ public class TiffImagingParameters extends XmpImagingParameters<TiffImagingParam
/**
* Gets the LZW compression block size.
*
- * @return the LZW compression block size, or null if not set.
+ * @return The LZW compression block size, or null if not set.
*/
public Integer getLzwCompressionBlockSize() {
return lzwCompressionBlockSize;
@@ -190,7 +190,7 @@ public class TiffImagingParameters extends XmpImagingParameters<TiffImagingParam
/**
* Gets the T.4 options.
*
- * @return the T.4 options, or null if not set.
+ * @return The T.4 options, or null if not set.
*/
public Integer getT4Options() {
return t4Options;
@@ -199,7 +199,7 @@ public class TiffImagingParameters extends XmpImagingParameters<TiffImagingParam
/**
* Gets the T.6 options.
*
- * @return the T.6 options, or null if not set.
+ * @return The T.6 options, or null if not set.
*/
public Integer getT6Options() {
return t6Options;
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 2ec7ec5d..5aa2c940 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
@@ -124,7 +124,7 @@ public final class TiffRasterDataFloat extends AbstractTiffRasterData {
* <p>
* See the class API documentation above for notes on accessing array elements.
*
- * @return the integer equivalents to the data content stored in this instance.
+ * @return The integer equivalents to the data content stored in this instance.
*/
@Override
public int[] getIntData() {
@@ -136,7 +136,7 @@ public final class TiffRasterDataFloat extends AbstractTiffRasterData {
*
* @param x integer coordinate in the columnar direction
* @param y integer coordinate in the row direction
- * @return the value stored at the specified location
+ * @return The value stored at the specified location
*/
@Override
public int getIntValue(final int x, final int y) {
@@ -149,7 +149,7 @@ public final class TiffRasterDataFloat extends AbstractTiffRasterData {
* @param x integer coordinate in the columnar direction
* @param y integer coordinate in the row direction
* @param i integer sample index (for data sets giving multiple samples per raster cell).
- * @return the value stored at the specified location
+ * @return The value stored at the specified location
*/
@Override
public int getIntValue(final int x, final int y, final int i) {
@@ -182,7 +182,7 @@ public final class TiffRasterDataFloat extends AbstractTiffRasterData {
*
* @param x integer coordinate in the columnar direction
* @param y integer coordinate in the row direction
- * @return the value stored at the specified location; potentially a Float.NaN.
+ * @return The value stored at the specified location; potentially a Float.NaN.
*/
@Override
public float getValue(final int x, final int y) {
@@ -195,7 +195,7 @@ public final class TiffRasterDataFloat extends AbstractTiffRasterData {
* @param x integer coordinate in the columnar direction
* @param y integer coordinate in the row direction
* @param i integer sample index (for data sets giving multiple samples per raster cell).
- * @return the value stored at the specified location; potentially a Float.NaN.
+ * @return The value stored at the specified location; potentially a Float.NaN.
*/
@Override
public float getValue(final int x, final int y, final int i) {
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 d97f7250..c1650f9c 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
@@ -96,7 +96,7 @@ public final class TiffRasterDataInt extends AbstractTiffRasterData {
* Returns an array of floating-point equivalents to the integer values stored in this instance. To do so, a float array is allocated and each integer value
* in the source data is cast to a float.
*
- * @return the floating-point equivalents of the content stored in this instance.
+ * @return The floating-point equivalents of the content stored in this instance.
*/
@Override
public float[] getData() {
@@ -135,7 +135,7 @@ public final class TiffRasterDataInt extends AbstractTiffRasterData {
*
* @param x integer coordinate in the columnar direction
* @param y integer coordinate in the row direction
- * @return the value stored at the specified location
+ * @return The value stored at the specified location
*/
@Override
public int getIntValue(final int x, final int y) {
@@ -148,7 +148,7 @@ public final class TiffRasterDataInt extends AbstractTiffRasterData {
* @param x integer coordinate in the columnar direction
* @param y integer coordinate in the row direction
* @param i integer sample index (for data sets giving multiple samples per raster cell).
- * @return the value stored at the specified location
+ * @return The value stored at the specified location
*/
@Override
public int getIntValue(final int x, final int y, final int i) {
@@ -181,7 +181,7 @@ public final class TiffRasterDataInt extends AbstractTiffRasterData {
*
* @param x integer coordinate in the columnar direction
* @param y integer coordinate in the row direction
- * @return the value stored at the specified location; potentially a Float.NaN.
+ * @return The value stored at the specified location; potentially a Float.NaN.
*/
@Override
public float getValue(final int x, final int y) {
@@ -194,7 +194,7 @@ public final class TiffRasterDataInt extends AbstractTiffRasterData {
* @param x integer coordinate in the columnar direction
* @param y integer coordinate in the row direction
* @param i integer sample index (for data sets giving multiple samples per raster cell.
- * @return the value stored at the specified location; potentially a Float.NaN.
+ * @return The value stored at the specified location; potentially a Float.NaN.
*/
@Override
public float getValue(final int x, final int y, final int i) {
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterStatistics.java b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterStatistics.java
index c338aba3..5a72a9dc 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterStatistics.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterStatistics.java
@@ -75,7 +75,7 @@ public class TiffRasterStatistics {
/**
* Gets the count of the number of null samples in the collection.
*
- * @return the a positive number, potentially zero
+ * @return The a positive number, potentially zero
*/
public int getCountOfNulls() {
return nNull;
@@ -84,7 +84,7 @@ public class TiffRasterStatistics {
/**
* Gets the count of the number of non-null and non-excluded samples in the collection.
*
- * @return the a positive number, potentially zero
+ * @return The a positive number, potentially zero
*/
public int getCountOfSamples() {
return nSample;
@@ -93,7 +93,7 @@ public class TiffRasterStatistics {
/**
* Gets the value that was set for exclusion, or a Float.NaN if not was set.
*
- * @return the excluded value (if any).
+ * @return The excluded value (if any).
*/
public float getExcludedValue() {
return excludedValue;
@@ -102,7 +102,7 @@ public class TiffRasterStatistics {
/**
* Gets the maximum value found in the source data
*
- * @return the maximum value found in the source data
+ * @return The maximum value found in the source data
*/
public float getMaxValue() {
return maxValue;
@@ -111,7 +111,7 @@ public class TiffRasterStatistics {
/**
* Gets the mean value for all sample values in the raster. Null-data values and excluded values are not considered.
*
- * @return the mean value of the samples
+ * @return The mean value of the samples
*/
public float getMeanValue() {
return meanValue;
@@ -120,7 +120,7 @@ public class TiffRasterStatistics {
/**
* Gets the minimum value found in the source data
*
- * @return the minimum value found in the source data
+ * @return The minimum value found in the source data
*/
public float getMinValue() {
return minValue;
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffReader.java b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffReader.java
index 437b916e..ce7260bc 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffReader.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffReader.java
@@ -266,7 +266,7 @@ public class TiffReader extends BinaryFileParser {
* @param byteSource the byte source.
* @param params the imaging parameters.
* @param formatCompliance the format compliance.
- * @return the TIFF contents.
+ * @return The TIFF contents.
* @throws ImagingException if an imaging error occurs.
* @throws IOException if an I/O error occurs.
*/
@@ -284,7 +284,7 @@ public class TiffReader extends BinaryFileParser {
* @param byteSource the byte source.
* @param readImageData true to read image data, false otherwise.
* @param formatCompliance the format compliance.
- * @return the TIFF contents.
+ * @return The TIFF contents.
* @throws ImagingException if an imaging error occurs.
* @throws IOException if an I/O error occurs.
*/
@@ -493,7 +493,7 @@ public class TiffReader extends BinaryFileParser {
* @param byteSource the byte source.
* @param readImageData true to read image data, false otherwise.
* @param formatCompliance the format compliance.
- * @return the TIFF contents containing only the first directory.
+ * @return The TIFF contents containing only the first directory.
* @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/formats/tiff/constants/TiffDirectoryType.java b/src/main/java/org/apache/commons/imaging/formats/tiff/constants/TiffDirectoryType.java
index 85db8afe..db87b8c7 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/constants/TiffDirectoryType.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/constants/TiffDirectoryType.java
@@ -76,7 +76,7 @@ public enum TiffDirectoryType {
* Gets the EXIF directory type for the given type code.
*
* @param type the directory type code.
- * @return the directory type, or {@link #EXIF_DIRECTORY_UNKNOWN} if not found.
+ * @return The directory type, or {@link #EXIF_DIRECTORY_UNKNOWN} if not found.
*/
public static TiffDirectoryType getExifDirectoryType(final int type) {
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 d5c14c51..112f4c2b 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
@@ -195,7 +195,7 @@ public abstract class AbstractImageDataReader {
* Applies the predictor to the samples.
*
* @param samples the samples array.
- * @return the modified samples array.
+ * @return The modified samples array.
*/
protected int[] applyPredictor(final int[] samples) {
if (predictor == 2) {
@@ -236,7 +236,7 @@ public abstract class AbstractImageDataReader {
* @param expectedSize the expected size of the decompressed data.
* @param tileWidth the tile width.
* @param tileHeight the tile height.
- * @return the decompressed data.
+ * @return The decompressed data.
* @throws ImagingException if the image format is invalid.
* @throws IOException if an I/O error occurs.
*/
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 34955459..b466cb1c 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
@@ -165,7 +165,7 @@ public abstract class AbstractFieldType {
* Gets a known field type.
*
* @param type the type to find.
- * @return the matching field type.
+ * @return The matching field type.
* @throws ImagingException thrown when not found.
*/
public static AbstractFieldType getFieldType(final int type) throws ImagingException {
@@ -199,7 +199,7 @@ public abstract class AbstractFieldType {
/**
* Gets the name.
*
- * @return the name.
+ * @return The name.
*/
public String getName() {
return name;
@@ -208,7 +208,7 @@ public abstract class AbstractFieldType {
/**
* Gets the size.
*
- * @return the size.
+ * @return The size.
*/
public int getSize() {
return elementSize;
@@ -217,7 +217,7 @@ public abstract class AbstractFieldType {
/**
* Gets the type.
*
- * @return the type.
+ * @return The type.
*/
public int getType() {
return type;
@@ -227,7 +227,7 @@ public abstract class AbstractFieldType {
* Gets the value from a TIFF field.
*
* @param entry the TIFF field.
- * @return the value.
+ * @return The value.
*/
public abstract Object getValue(TiffField entry);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/itu_t4/T4AndT6Compression.java b/src/main/java/org/apache/commons/imaging/formats/tiff/itu_t4/T4AndT6Compression.java
index 362b820a..659cabb0 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/itu_t4/T4AndT6Compression.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/itu_t4/T4AndT6Compression.java
@@ -117,7 +117,7 @@ public final class T4AndT6Compression {
* @param uncompressed uncompressed byte data
* @param width image width
* @param height image height
- * @return the compressed data
+ * @return The compressed data
* @throws ImagingException if it fails to write the compressed data
*/
public static byte[] compressModifiedHuffman(final byte[] uncompressed, final int width, final int height) throws ImagingException {
@@ -179,7 +179,7 @@ public final class T4AndT6Compression {
* @param width the image width.
* @param height the image height.
* @param hasFill whether to use fill bits.
- * @return the compressed data.
+ * @return The compressed data.
* @throws ImagingException if an imaging error occurs.
*/
public static byte[] compressT4_1D(final byte[] uncompressed, final int width, final int height, final boolean hasFill) throws ImagingException {
@@ -219,7 +219,7 @@ public final class T4AndT6Compression {
* @param height the image height.
* @param hasFill whether to use fill bits.
* @param parameterK the K parameter.
- * @return the compressed data.
+ * @return The compressed data.
* @throws ImagingException if an imaging error occurs.
*/
public static byte[] compressT4_2D(final byte[] uncompressed, final int width, final int height, final boolean hasFill, final int parameterK)
@@ -306,7 +306,7 @@ public final class T4AndT6Compression {
* @param uncompressed the uncompressed data.
* @param width the image width.
* @param height the image height.
- * @return the compressed data.
+ * @return The compressed data.
* @throws ImagingException if an imaging error occurs.
*/
public static byte[] compressT6(final byte[] uncompressed, final int width, final int height) throws ImagingException {
@@ -368,7 +368,7 @@ public final class T4AndT6Compression {
* @param compressed compressed byte data
* @param width image width
* @param height image height
- * @return the compressed data
+ * @return The compressed data
* @throws ImagingException if it fails to read the compressed data
*/
public static byte[] decompressModifiedHuffman(final byte[] compressed, final int width, final int height) throws ImagingException {
@@ -407,7 +407,7 @@ public final class T4AndT6Compression {
* @param width image width
* @param height image height
* @param hasFill used to check the end of line
- * @return the decompressed data
+ * @return The decompressed data
* @throws ImagingException if it fails to read the compressed data
*/
public static byte[] decompressT4_1D(final byte[] compressed, final int width, final int height, final boolean hasFill) throws ImagingException {
@@ -451,7 +451,7 @@ public final class T4AndT6Compression {
* @param width image width
* @param height image height
* @param hasFill used to check the end of line
- * @return the decompressed data
+ * @return The decompressed data
* @throws ImagingException if it fails to read the compressed data
*/
public static byte[] decompressT4_2D(final byte[] compressed, final int width, final int height, final boolean hasFill) throws ImagingException {
@@ -556,7 +556,7 @@ public final class T4AndT6Compression {
* @param compressed compressed byte data
* @param width image width
* @param height image height
- * @return the decompressed data
+ * @return The decompressed data
* @throws ImagingException if it fails to read the compressed data
*/
public static byte[] decompressT6(final byte[] compressed, final int width, final int height) throws ImagingException {
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/AbstractPhotometricInterpreter.java b/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/AbstractPhotometricInterpreter.java
index c5f6691e..dbe87b3d 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/AbstractPhotometricInterpreter.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/AbstractPhotometricInterpreter.java
@@ -65,7 +65,7 @@ public abstract class AbstractPhotometricInterpreter {
* Gets the bits per sample at the specified offset.
*
* @param offset the sample offset.
- * @return the bits per sample.
+ * @return The bits per sample.
*/
protected int getBitsPerSample(final int offset) {
return bitsPerSample[offset];
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/PhotometricInterpreterYCbCr.java b/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/PhotometricInterpreterYCbCr.java
index 140853bd..8eb69435 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/PhotometricInterpreterYCbCr.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/PhotometricInterpreterYCbCr.java
@@ -56,7 +56,7 @@ public class PhotometricInterpreterYCbCr extends AbstractPhotometricInterpreter
* @param value the value to limit.
* @param min the minimum value.
* @param max the maximum value.
- * @return the limited value.
+ * @return The limited value.
*/
public static int limit(final int value, final int min, final int max) {
return Math.min(max, Math.max(min, value));
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfo.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfo.java
index b83aa6c0..b071bcf5 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfo.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfo.java
@@ -143,7 +143,7 @@ public class TagInfo {
* @param abstractFieldType the field type.
* @param value the value.
* @param byteOrder the byte order.
- * @return the encoded bytes.
+ * @return The encoded bytes.
* @throws ImagingException if an imaging error occurs.
*/
public byte[] encodeValue(final AbstractFieldType abstractFieldType, final Object value, final ByteOrder byteOrder) throws ImagingException {
@@ -153,7 +153,7 @@ public class TagInfo {
/**
* Gets the description.
*
- * @return the description.
+ * @return The description.
*/
public String getDescription() {
return tag + " (0x" + Integer.toHexString(tag) + ": " + name + "): ";
@@ -163,7 +163,7 @@ public class TagInfo {
* Gets the value from a TIFF field.
*
* @param entry the TIFF field whose value to return.
- * @return the value of the TIFF field.
+ * @return The value of the TIFF field.
* @throws ImagingException thrown by subclasses.
*/
public Object getValue(final TiffField entry) throws ImagingException {
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoAscii.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoAscii.java
index 0fde3e2e..5e283a14 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoAscii.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoAscii.java
@@ -46,7 +46,7 @@ public class TagInfoAscii extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
* @throws ImagingException if an imaging error occurs.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final String... values) throws ImagingException {
@@ -58,7 +58,7 @@ public class TagInfoAscii extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the string array value.
+ * @return The string array value.
*/
public String[] getValue(final ByteOrder byteOrder, final byte[] bytes) {
int nullCount = 0;
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoByte.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoByte.java
index e0a41cc5..b00e1ed9 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoByte.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoByte.java
@@ -67,7 +67,7 @@ public class TagInfoByte extends TagInfo {
*
* @param byteOrder the byte order.
* @param value the value.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final byte value) {
return new byte[] { value };
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoByteOrShort.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoByteOrShort.java
index 52474242..bc9bd85d 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoByteOrShort.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoByteOrShort.java
@@ -44,7 +44,7 @@ public class TagInfoByteOrShort extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final byte... values) {
return values;
@@ -55,7 +55,7 @@ public class TagInfoByteOrShort extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final short... values) {
return ByteConversions.toBytes(values, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoBytes.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoBytes.java
index 6e01198d..154b8526 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoBytes.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoBytes.java
@@ -71,7 +71,7 @@ public class TagInfoBytes extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final byte... values) {
return values;
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoDouble.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoDouble.java
index 14be4bae..175d3fc5 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoDouble.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoDouble.java
@@ -43,7 +43,7 @@ public class TagInfoDouble extends TagInfo {
*
* @param byteOrder the byte order.
* @param value the value.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final double value) {
return ByteConversions.toBytes(value, byteOrder);
@@ -54,7 +54,7 @@ public class TagInfoDouble extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the double value.
+ * @return The double value.
*/
public double getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toDouble(bytes, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoDoubles.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoDoubles.java
index b1b499fb..1a995e57 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoDoubles.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoDoubles.java
@@ -44,7 +44,7 @@ public class TagInfoDoubles extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final double... values) {
return ByteConversions.toBytes(values, byteOrder);
@@ -55,7 +55,7 @@ public class TagInfoDoubles extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the double array values.
+ * @return The double array values.
*/
public double[] getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toDoubles(bytes, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoFloat.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoFloat.java
index 1b92cda8..19f23cad 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoFloat.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoFloat.java
@@ -43,7 +43,7 @@ public class TagInfoFloat extends TagInfo {
*
* @param byteOrder the byte order.
* @param value the value.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final float value) {
return ByteConversions.toBytes(value, byteOrder);
@@ -54,7 +54,7 @@ public class TagInfoFloat extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the float value.
+ * @return The float value.
*/
public float getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toFloat(bytes, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoFloats.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoFloats.java
index 78db17e1..1b97eeba 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoFloats.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoFloats.java
@@ -44,7 +44,7 @@ public class TagInfoFloats extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final float... values) {
return ByteConversions.toBytes(values, byteOrder);
@@ -55,7 +55,7 @@ public class TagInfoFloats extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the float array values.
+ * @return The float array values.
*/
public float[] getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toFloats(bytes, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoLong.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoLong.java
index 1d1c3720..39b9f67e 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoLong.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoLong.java
@@ -71,7 +71,7 @@ public class TagInfoLong extends TagInfo {
*
* @param byteOrder the byte order.
* @param value the value.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final int value) {
return ByteConversions.toBytes(value, byteOrder);
@@ -82,7 +82,7 @@ public class TagInfoLong extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the integer value.
+ * @return The integer value.
*/
public int getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toInt(bytes, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoLongOrIfd.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoLongOrIfd.java
index 7c9cc110..43bb54ba 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoLongOrIfd.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoLongOrIfd.java
@@ -57,7 +57,7 @@ public class TagInfoLongOrIfd extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final int... values) {
return ByteConversions.toBytes(values, byteOrder);
@@ -68,7 +68,7 @@ public class TagInfoLongOrIfd extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the integer array values.
+ * @return The integer array values.
*/
public int[] getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toInts(bytes, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoLongs.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoLongs.java
index 6a456d1e..03b41125 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoLongs.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoLongs.java
@@ -57,7 +57,7 @@ public class TagInfoLongs extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final int... values) {
return ByteConversions.toBytes(values, byteOrder);
@@ -68,7 +68,7 @@ public class TagInfoLongs extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the integer array values.
+ * @return The integer array values.
*/
public int[] getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toInts(bytes, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoRational.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoRational.java
index 58bd6716..88f2661e 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoRational.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoRational.java
@@ -44,7 +44,7 @@ public class TagInfoRational extends TagInfo {
*
* @param byteOrder the byte order.
* @param value the value.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final RationalNumber value) {
return ByteConversions.toBytes(value, byteOrder);
@@ -55,7 +55,7 @@ public class TagInfoRational extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the rational number value.
+ * @return The rational number value.
*/
public RationalNumber getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toRational(bytes, byteOrder, true);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoRationals.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoRationals.java
index 85ea84a8..c5b6a3e7 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoRationals.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoRationals.java
@@ -45,7 +45,7 @@ public class TagInfoRationals extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final RationalNumber... values) {
return ByteConversions.toBytes(values, byteOrder);
@@ -56,7 +56,7 @@ public class TagInfoRationals extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the rational number array values.
+ * @return The rational number array values.
*/
public RationalNumber[] getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toRationals(bytes, byteOrder, true);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSByte.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSByte.java
index 1f2fbd27..5e9885b8 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSByte.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSByte.java
@@ -42,7 +42,7 @@ public class TagInfoSByte extends TagInfo {
*
* @param byteOrder the byte order.
* @param value the value.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final byte value) {
return new byte[] { value };
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSBytes.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSBytes.java
index 814b0e27..cf517407 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSBytes.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSBytes.java
@@ -43,7 +43,7 @@ public class TagInfoSBytes extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final byte... values) {
return values;
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSLong.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSLong.java
index 9e4a0b5e..c2f8ea6a 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSLong.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSLong.java
@@ -43,7 +43,7 @@ public class TagInfoSLong extends TagInfo {
*
* @param byteOrder the byte order.
* @param value the value.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final int value) {
return ByteConversions.toBytes(value, byteOrder);
@@ -54,7 +54,7 @@ public class TagInfoSLong extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the integer value.
+ * @return The integer value.
*/
public int getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toInt(bytes, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSLongs.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSLongs.java
index 1ff4f3c6..30448950 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSLongs.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSLongs.java
@@ -44,7 +44,7 @@ public class TagInfoSLongs extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final int... values) {
return ByteConversions.toBytes(values, byteOrder);
@@ -55,7 +55,7 @@ public class TagInfoSLongs extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the integer array values.
+ * @return The integer array values.
*/
public int[] getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toInts(bytes, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSRational.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSRational.java
index 9f2fdf8f..e48a91a6 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSRational.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSRational.java
@@ -44,7 +44,7 @@ public class TagInfoSRational extends TagInfo {
*
* @param byteOrder the byte order.
* @param value the value.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final RationalNumber value) {
return ByteConversions.toBytes(value, byteOrder);
@@ -55,7 +55,7 @@ public class TagInfoSRational extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the rational number value.
+ * @return The rational number value.
*/
public RationalNumber getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toRational(bytes, byteOrder, false);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSRationals.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSRationals.java
index 81889f46..66325db3 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSRationals.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSRationals.java
@@ -45,7 +45,7 @@ public class TagInfoSRationals extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final RationalNumber... values) {
return ByteConversions.toBytes(values, byteOrder);
@@ -56,7 +56,7 @@ public class TagInfoSRationals extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the rational number array values.
+ * @return The rational number array values.
*/
public RationalNumber[] getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toRationals(bytes, byteOrder, false);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSShort.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSShort.java
index 2ae2b29c..5f5bded0 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSShort.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSShort.java
@@ -43,7 +43,7 @@ public class TagInfoSShort extends TagInfo {
*
* @param byteOrder the byte order.
* @param value the value.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final short value) {
return ByteConversions.toBytes(value, byteOrder);
@@ -54,7 +54,7 @@ public class TagInfoSShort extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the short value.
+ * @return The short value.
*/
public short getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toShort(bytes, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSShorts.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSShorts.java
index ac8f7e23..be7bf926 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSShorts.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoSShorts.java
@@ -44,7 +44,7 @@ public class TagInfoSShorts extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final short... values) {
return ByteConversions.toBytes(values, byteOrder);
@@ -55,7 +55,7 @@ public class TagInfoSShorts extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the short array values.
+ * @return The short array values.
*/
public short[] getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toShorts(bytes, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShort.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShort.java
index 9a7a8da7..58d1ceaa 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShort.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShort.java
@@ -43,7 +43,7 @@ public class TagInfoShort extends TagInfo {
*
* @param byteOrder the byte order.
* @param value the value.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final short value) {
return ByteConversions.toBytes(value, byteOrder);
@@ -54,7 +54,7 @@ public class TagInfoShort extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the short value.
+ * @return The short value.
*/
public short getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toShort(bytes, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShortOrLong.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShortOrLong.java
index 4749aee7..e2dc8305 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShortOrLong.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShortOrLong.java
@@ -57,7 +57,7 @@ public class TagInfoShortOrLong extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final int... values) {
return ByteConversions.toBytes(values, byteOrder);
@@ -68,7 +68,7 @@ public class TagInfoShortOrLong extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final short... values) {
return ByteConversions.toBytes(values, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShortOrLongOrRational.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShortOrLongOrRational.java
index 5ff14632..81614057 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShortOrLongOrRational.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShortOrLongOrRational.java
@@ -45,7 +45,7 @@ public class TagInfoShortOrLongOrRational extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final int... values) {
return ByteConversions.toBytes(values, byteOrder);
@@ -56,7 +56,7 @@ public class TagInfoShortOrLongOrRational extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final RationalNumber... values) {
return ByteConversions.toBytes(values, byteOrder);
@@ -67,7 +67,7 @@ public class TagInfoShortOrLongOrRational extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final short... values) {
return ByteConversions.toBytes(values, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShortOrRational.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShortOrRational.java
index d7350b5f..c7a18e14 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShortOrRational.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShortOrRational.java
@@ -45,7 +45,7 @@ public class TagInfoShortOrRational extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final RationalNumber... values) {
return ByteConversions.toBytes(values, byteOrder);
@@ -56,7 +56,7 @@ public class TagInfoShortOrRational extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final short... values) {
return ByteConversions.toBytes(values, byteOrder);
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShorts.java b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShorts.java
index c248d55b..c228de23 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShorts.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoShorts.java
@@ -44,7 +44,7 @@ public class TagInfoShorts extends TagInfo {
*
* @param byteOrder the byte order.
* @param values the values.
- * @return the encoded bytes.
+ * @return The encoded bytes.
*/
public byte[] encodeValue(final ByteOrder byteOrder, final short... values) {
return ByteConversions.toBytes(values, byteOrder);
@@ -55,7 +55,7 @@ public class TagInfoShorts extends TagInfo {
*
* @param byteOrder the byte order.
* @param bytes the bytes.
- * @return the short array values.
+ * @return The short array values.
*/
public short[] getValue(final ByteOrder byteOrder, final byte[] bytes) {
return ByteConversions.toShorts(bytes, byteOrder);
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 ec78aa3b..2c3a1cca 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
@@ -58,7 +58,7 @@ public abstract class AbstractTiffImageWriter {
* Calculates the padding length needed for image data alignment.
*
* @param dataLength the length of the data.
- * @return the padding length.
+ * @return The padding length.
*/
protected static int imageDataPaddingLength(final int dataLength) {
return (4 - dataLength % 4) % 4;
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/write/AbstractTiffOutputItem.java b/src/main/java/org/apache/commons/imaging/formats/tiff/write/AbstractTiffOutputItem.java
index 764c8228..db961f58 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/write/AbstractTiffOutputItem.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/write/AbstractTiffOutputItem.java
@@ -67,21 +67,21 @@ abstract class AbstractTiffOutputItem {
/**
* Gets a description of this item.
*
- * @return the item description.
+ * @return The item description.
*/
public abstract String getItemDescription();
/**
* Gets the length of this item in bytes.
*
- * @return the item length.
+ * @return The item length.
*/
public abstract int getItemLength();
/**
* Gets the offset of this item.
*
- * @return the offset.
+ * @return The offset.
*/
protected long getOffset() {
return offset;
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 bd1e8f03..dc49406c 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
@@ -666,7 +666,7 @@ public final class TiffOutputDirectory extends AbstractTiffOutputItem implements
/**
* Gets a description of this directory.
*
- * @return the description.
+ * @return The description.
*/
public String description() {
return TiffDirectory.description(getType());
@@ -680,7 +680,7 @@ public final class TiffOutputDirectory extends AbstractTiffOutputItem implements
* </p>
*
* @param tag the tag specifying the field
- * @return the field matching tagInfo or null, if the field isn't present
+ * @return The field matching tagInfo or null, if the field isn't present
* @see #findField(TagInfo)
*/
public TiffOutputField findField(final int tag) {
@@ -700,7 +700,7 @@ public final class TiffOutputDirectory extends AbstractTiffOutputItem implements
* </p>
*
* @param tagInfo the TagInfo specifying the field
- * @return the field matching tagInfo or null, if the field isn't present
+ * @return The field matching tagInfo or null, if the field isn't present
* @see #findField(int)
*/
public TiffOutputField findField(final TagInfo tagInfo) {
@@ -731,7 +731,7 @@ public final class TiffOutputDirectory extends AbstractTiffOutputItem implements
* Gets all output items from this directory including fields and image data.
*
* @param outputSummary the output summary.
- * @return the list of output items.
+ * @return The list of output items.
* @throws ImagingException if an error occurs.
*/
protected List<AbstractTiffOutputItem> getOutputItems(final TiffOutputSummary outputSummary) throws ImagingException {
@@ -826,7 +826,7 @@ public final class TiffOutputDirectory extends AbstractTiffOutputItem implements
/**
* Gets the raw JPEG image data.
*
- * @return the JPEG image data, or null if not present.
+ * @return The JPEG image data, or null if not present.
*/
public JpegImageData getRawJpegImageData() {
return jpegImageData;
@@ -835,7 +835,7 @@ public final class TiffOutputDirectory extends AbstractTiffOutputItem implements
/**
* Gets the raw TIFF image data.
*
- * @return the TIFF image data, or null if not present.
+ * @return The TIFF image data, or null if not present.
*/
public AbstractTiffImageData getRawTiffImageData() {
return abstractTiffImageData;
@@ -844,7 +844,7 @@ public final class TiffOutputDirectory extends AbstractTiffOutputItem implements
/**
* Gets the directory type.
*
- * @return the directory type.
+ * @return The directory type.
*/
public int getType() {
return type;
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 72662a9e..454f3247 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
@@ -38,7 +38,7 @@ public class TiffOutputField {
*
* @param tagInfo the tag info.
* @param byteOrder the byte order.
- * @return the offset field.
+ * @return The offset field.
* @throws ImagingException if an error occurs.
*/
protected static TiffOutputField createOffsetField(final TagInfo tagInfo, final ByteOrder byteOrder) throws ImagingException {
@@ -118,7 +118,7 @@ public class TiffOutputField {
/**
* Gets the separate value item if this field is not a local value.
*
- * @return the separate value item, or null.
+ * @return The separate value item, or null.
*/
protected AbstractTiffOutputItem getSeperateValue() {
return separateValueItem;
@@ -127,7 +127,7 @@ public class TiffOutputField {
/**
* Gets the sort hint.
*
- * @return the sort hint.
+ * @return The sort hint.
*/
public int getSortHint() {
return sortHint;
@@ -185,7 +185,7 @@ public class TiffOutputField {
* Gets a string representation with optional prefix.
*
* @param prefix the prefix, or null.
- * @return the string representation.
+ * @return The string representation.
*/
public String toString(String prefix) {
if (prefix == null) {
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 3a593702..ac7cad1d 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
@@ -76,7 +76,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
/**
* Adds an EXIF directory to this output set.
*
- * @return the new EXIF directory.
+ * @return The new EXIF directory.
* @throws ImagingException if an EXIF directory already exists.
*/
public TiffOutputDirectory addExifDirectory() throws ImagingException {
@@ -88,7 +88,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
/**
* Adds a GPS directory to this output set.
*
- * @return the new GPS directory.
+ * @return The new GPS directory.
* @throws ImagingException if a GPS directory already exists.
*/
public TiffOutputDirectory addGpsDirectory() throws ImagingException {
@@ -100,7 +100,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
/**
* Adds an Interoperability directory to this output set.
*
- * @return the new Interoperability directory.
+ * @return The new Interoperability directory.
* @throws ImagingException if an Interoperability directory already exists.
*/
public TiffOutputDirectory addInteroperabilityDirectory() throws ImagingException {
@@ -114,7 +114,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
/**
* Adds a Root directory to this output set.
*
- * @return the new Root directory.
+ * @return The new Root directory.
* @throws ImagingException if a Root directory already exists.
*/
public TiffOutputDirectory addRootDirectory() throws ImagingException {
@@ -134,7 +134,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
* Finds a directory of the specified type in this output set.
*
* @param directoryType the type of the directory to find.
- * @return the found directory, or null if no such directory exists.
+ * @return The found directory, or null if no such directory exists.
*/
public TiffOutputDirectory findDirectory(final int directoryType) {
for (final TiffOutputDirectory directory : directories) {
@@ -149,7 +149,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
* Finds a field with the specified tag in this output set.
*
* @param tag the tag of the field to find.
- * @return the found field, or null if no such field exists.
+ * @return The found field, or null if no such field exists.
*/
public TiffOutputField findField(final int tag) {
for (final TiffOutputDirectory directory : directories) {
@@ -165,7 +165,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
* Finds a field with the specified tag info in this output set.
*
* @param tagInfo the tag info of the field to find.
- * @return the found field, or null if no such field exists.
+ * @return The found field, or null if no such field exists.
*/
public TiffOutputField findField(final TagInfo tagInfo) {
return findField(tagInfo.tag);
@@ -183,7 +183,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
/**
* Gets the EXIF directory in this output set.
*
- * @return the EXIF directory, or null if no EXIF directory exists.
+ * @return The EXIF directory, or null if no EXIF directory exists.
*/
public TiffOutputDirectory getExifDirectory() {
return findDirectory(TiffDirectoryConstants.DIRECTORY_TYPE_EXIF);
@@ -192,7 +192,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
/**
* Gets the GPS directory in this output set.
*
- * @return the GPS directory, or null if no GPS directory exists.
+ * @return The GPS directory, or null if no GPS directory exists.
*/
public TiffOutputDirectory getGpsDirectory() {
return findDirectory(TiffDirectoryConstants.DIRECTORY_TYPE_GPS);
@@ -201,7 +201,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
/**
* Gets the Interoperability directory in this output set.
*
- * @return the Interoperability directory, or null if no Interoperability directory exists.
+ * @return The Interoperability directory, or null if no Interoperability directory exists.
*/
public TiffOutputDirectory getInteroperabilityDirectory() {
return findDirectory(TiffDirectoryConstants.DIRECTORY_TYPE_INTEROPERABILITY);
@@ -210,7 +210,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
/**
* Gets the EXIF directory in this output set, creating it if it doesn't exist.
*
- * @return the EXIF directory.
+ * @return The EXIF directory.
* @throws ImagingException if it fails to create the directory.
*/
public TiffOutputDirectory getOrCreateExifDirectory() throws ImagingException {
@@ -227,7 +227,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
/**
* Gets the GPS directory in this output set, creating it if it doesn't exist.
*
- * @return the GPS directory.
+ * @return The GPS directory.
* @throws ImagingException if it fails to create the directory.
*/
public TiffOutputDirectory getOrCreateGpsDirectory() throws ImagingException {
@@ -244,7 +244,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
/**
* Gets the Root directory in this output set, creating it if it doesn't exist.
*
- * @return the Root directory.
+ * @return The Root directory.
* @throws ImagingException if it fails to create the directory.
*/
public TiffOutputDirectory getOrCreateRootDirectory() throws ImagingException {
@@ -259,7 +259,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
* Gets all output items from all directories in this output set.
*
* @param outputSummary the output summary.
- * @return the list of all output items.
+ * @return The list of all output items.
* @throws ImagingException if an error occurs.
*/
protected List<AbstractTiffOutputItem> getOutputItems(final TiffOutputSummary outputSummary) throws ImagingException {
@@ -275,7 +275,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
/**
* Gets the Root directory in this output set.
*
- * @return the Root directory.
+ * @return The Root directory.
*/
public TiffOutputDirectory getRootDirectory() {
return findDirectory(TiffDirectoryConstants.DIRECTORY_TYPE_ROOT);
@@ -380,7 +380,7 @@ public final class TiffOutputSet implements Iterable<TiffOutputDirectory> {
* Gets a string representation with optional prefix.
*
* @param prefix the prefix, or null.
- * @return the string representation.
+ * @return The string representation.
*/
public String toString(String prefix) {
if (prefix == null) {
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 4c7d0645..66904782 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
@@ -96,7 +96,7 @@ public abstract class AbstractWebPChunk extends BinaryFileParser {
/**
* Gets the chunk size.
*
- * @return the chunk size.
+ * @return The chunk size.
*/
public int getChunkSize() {
return chunkSize;
@@ -105,7 +105,7 @@ public abstract class AbstractWebPChunk extends BinaryFileParser {
/**
* Gets the payload size.
*
- * @return the payload size.
+ * @return The payload size.
*/
public int getPayloadSize() {
return size;
@@ -114,7 +114,7 @@ public abstract class AbstractWebPChunk extends BinaryFileParser {
/**
* Gets the chunk type.
*
- * @return the chunk type.
+ * @return The chunk type.
*/
public int getType() {
return type;
@@ -123,7 +123,7 @@ public abstract class AbstractWebPChunk extends BinaryFileParser {
/**
* Gets the description of the chunk type.
*
- * @return the description of the chunk type.
+ * @return The description of the chunk type.
*/
public String getTypeDescription() {
return new String(new byte[] { (byte) (type & 0xff), (byte) (type >> 8 & 0xff), (byte) (type >> 16 & 0xff), (byte) (type >> 24 & 0xff) },
diff --git a/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkVp8.java b/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkVp8.java
index 55349c05..06edfb5c 100644
--- a/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkVp8.java
+++ b/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkVp8.java
@@ -132,7 +132,7 @@ public final class WebPChunkVp8 extends AbstractWebPChunk {
/**
* Gets the height of the image.
*
- * @return the height.
+ * @return The height.
*/
public int getHeight() {
return height;
@@ -141,7 +141,7 @@ public final class WebPChunkVp8 extends AbstractWebPChunk {
/**
* Gets the horizontal scale.
*
- * @return the horizontal scale.
+ * @return The horizontal scale.
*/
public int getHorizontalScale() {
return horizontalScale;
@@ -150,7 +150,7 @@ public final class WebPChunkVp8 extends AbstractWebPChunk {
/**
* Gets the version number.
*
- * @return the version number.
+ * @return The version number.
*/
public int getVersionNumber() {
return versionNumber;
@@ -159,7 +159,7 @@ public final class WebPChunkVp8 extends AbstractWebPChunk {
/**
* Gets the vertical scale.
*
- * @return the vertical scale.
+ * @return The vertical scale.
*/
public int getVerticalScale() {
return verticalScale;
@@ -168,7 +168,7 @@ public final class WebPChunkVp8 extends AbstractWebPChunk {
/**
* Gets the width of the image.
*
- * @return the width.
+ * @return The width.
*/
public int getWidth() {
return width;
diff --git a/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkVp8l.java b/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkVp8l.java
index fd02273a..34162ea5 100644
--- a/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkVp8l.java
+++ b/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkVp8l.java
@@ -87,7 +87,7 @@ public final class WebPChunkVp8l extends AbstractWebPChunk {
/**
* Gets the image height.
*
- * @return the image height.
+ * @return The image height.
*/
public int getImageHeight() {
return imageHeight;
@@ -96,7 +96,7 @@ public final class WebPChunkVp8l extends AbstractWebPChunk {
/**
* Gets the image width.
*
- * @return the image width.
+ * @return The image width.
*/
public int getImageWidth() {
return imageWidth;
@@ -105,7 +105,7 @@ public final class WebPChunkVp8l extends AbstractWebPChunk {
/**
* Gets the version number.
*
- * @return the version number.
+ * @return The version number.
*/
public int getVersionNumber() {
return versionNumber;
diff --git a/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkVp8x.java b/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkVp8x.java
index fb008d13..cea9c25e 100644
--- a/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkVp8x.java
+++ b/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkVp8x.java
@@ -100,7 +100,7 @@ public final class WebPChunkVp8x extends AbstractWebPChunk {
/**
* Gets the canvas height.
*
- * @return the canvas height.
+ * @return The canvas height.
*/
public int getCanvasHeight() {
return canvasHeight;
@@ -109,7 +109,7 @@ public final class WebPChunkVp8x extends AbstractWebPChunk {
/**
* Gets the canvas width.
*
- * @return the canvas width.
+ * @return The canvas width.
*/
public int getCanvasWidth() {
return canvasWidth;
diff --git a/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkXml.java b/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkXml.java
index 94210ee8..03ba58c7 100644
--- a/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkXml.java
+++ b/src/main/java/org/apache/commons/imaging/formats/webp/chunks/WebPChunkXml.java
@@ -56,7 +56,7 @@ public final class WebPChunkXml extends AbstractWebPChunk {
/**
* Gets the XML content.
*
- * @return the XML.
+ * @return The XML.
*/
public String getXml() {
return xml;
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 a85967de..193f6fd8 100644
--- a/src/main/java/org/apache/commons/imaging/icc/IccProfileInfo.java
+++ b/src/main/java/org/apache/commons/imaging/icc/IccProfileInfo.java
@@ -147,7 +147,7 @@ public class IccProfileInfo {
/**
* Gets the ICC tags.
*
- * @return the array of ICC tags.
+ * @return The array of ICC tags.
*/
public IccTag[] getTags() {
return tags;
diff --git a/src/main/java/org/apache/commons/imaging/icc/IccProfileParser.java b/src/main/java/org/apache/commons/imaging/icc/IccProfileParser.java
index 74a096db..edfce65c 100644
--- a/src/main/java/org/apache/commons/imaging/icc/IccProfileParser.java
+++ b/src/main/java/org/apache/commons/imaging/icc/IccProfileParser.java
@@ -51,7 +51,7 @@ public class IccProfileParser extends BinaryFileParser {
* Gets ICC profile info from bytes.
*
* @param bytes the bytes.
- * @return the ICC profile info or null if bytes is null.
+ * @return The ICC profile info or null if bytes is null.
* @throws IOException if an I/O error occurs.
*/
public IccProfileInfo getIccProfileInfo(final byte[] bytes) throws IOException {
@@ -65,7 +65,7 @@ public class IccProfileParser extends BinaryFileParser {
* Gets ICC profile info from byte source.
*
* @param byteSource the byte source.
- * @return the ICC profile info.
+ * @return The ICC profile info.
* @throws IOException if an I/O error occurs.
*/
public IccProfileInfo getIccProfileInfo(final ByteSource byteSource) throws IOException {
@@ -89,7 +89,7 @@ public class IccProfileParser extends BinaryFileParser {
* Gets ICC profile info from file.
*
* @param file the file.
- * @return the ICC profile info or null if file is null.
+ * @return The ICC profile info or null if file is null.
* @throws IOException if an I/O error occurs.
*/
public IccProfileInfo getIccProfileInfo(final File file) throws IOException {
@@ -104,7 +104,7 @@ public class IccProfileParser extends BinaryFileParser {
* Gets ICC profile info from ICC_Profile.
*
* @param iccProfile the ICC profile.
- * @return the ICC profile info or null if iccProfile is null.
+ * @return The ICC profile info or null if iccProfile is null.
* @throws IOException if an I/O error occurs.
*/
public IccProfileInfo getIccProfileInfo(final ICC_Profile iccProfile) throws IOException {
diff --git a/src/main/java/org/apache/commons/imaging/internal/ImageParserFactory.java b/src/main/java/org/apache/commons/imaging/internal/ImageParserFactory.java
index 6ad9a5a8..c3d8720d 100644
--- a/src/main/java/org/apache/commons/imaging/internal/ImageParserFactory.java
+++ b/src/main/java/org/apache/commons/imaging/internal/ImageParserFactory.java
@@ -40,7 +40,7 @@ public final class ImageParserFactory {
*
* @param <T> The imaging parameters type.
* @param byteSource the byte source.
- * @return the image parser.
+ * @return The image parser.
* @throws IOException if an I/O error occurs.
*/
public static <T extends ImagingParameters<T>> AbstractImageParser<T> getImageParser(final ByteSource byteSource) throws IOException {
@@ -61,7 +61,7 @@ public final class ImageParserFactory {
*
* @param <T> The imaging parameters type.
* @param format the image format.
- * @return the image parser.
+ * @return The image parser.
*/
public static <T extends ImagingParameters<T>> AbstractImageParser<T> getImageParser(final ImageFormat format) {
return getImageParser(parser -> parser.canAcceptType(format), () -> new IllegalArgumentException("Unknown ImageFormat: " + format));
@@ -80,7 +80,7 @@ public final class ImageParserFactory {
*
* @param <T> The imaging parameters type.
* @param fileExtension the file extension.
- * @return the image parser.
+ * @return The image parser.
*/
public static <T extends ImagingParameters<T>> AbstractImageParser<T> getImageParser(final String fileExtension) {
return getImageParser(parser -> parser.canAcceptExtension(fileExtension), () -> new IllegalArgumentException("Unknown extension: " + fileExtension));
diff --git a/src/main/java/org/apache/commons/imaging/internal/SafeOperations.java b/src/main/java/org/apache/commons/imaging/internal/SafeOperations.java
index 6fae5bf4..62702ea9 100644
--- a/src/main/java/org/apache/commons/imaging/internal/SafeOperations.java
+++ b/src/main/java/org/apache/commons/imaging/internal/SafeOperations.java
@@ -29,7 +29,7 @@ public final class SafeOperations {
* Applies {@link Math#addExact(int, int)} to a variable length array of integers.
*
* @param values variable length array of integers.
- * @return the values safely added.
+ * @return The values safely added.
*/
public static int add(final int... values) {
if (values == null || values.length < 2) {
diff --git a/src/main/java/org/apache/commons/imaging/mylzw/BitsToByteInputStream.java b/src/main/java/org/apache/commons/imaging/mylzw/BitsToByteInputStream.java
index 79db9e4e..90530656 100644
--- a/src/main/java/org/apache/commons/imaging/mylzw/BitsToByteInputStream.java
+++ b/src/main/java/org/apache/commons/imaging/mylzw/BitsToByteInputStream.java
@@ -47,7 +47,7 @@ public class BitsToByteInputStream extends FilterInputStream {
* Reads the specified number of bits and adjusts to the desired depth.
*
* @param bitCount the number of bits to read.
- * @return the adjusted value.
+ * @return The adjusted value.
* @throws IOException if an I/O error occurs.
*/
public int readBits(final int bitCount) throws IOException {
@@ -66,7 +66,7 @@ public class BitsToByteInputStream extends FilterInputStream {
*
* @param sampleBits the number of bits per sample.
* @param length the number of samples to read.
- * @return the array of values.
+ * @return The array of values.
* @throws IOException if an I/O error occurs.
*/
public int[] readBitsArray(final int sampleBits, final int length) throws IOException {
diff --git a/src/main/java/org/apache/commons/imaging/mylzw/MyBitInputStream.java b/src/main/java/org/apache/commons/imaging/mylzw/MyBitInputStream.java
index 43783d05..60bcdcbe 100644
--- a/src/main/java/org/apache/commons/imaging/mylzw/MyBitInputStream.java
+++ b/src/main/java/org/apache/commons/imaging/mylzw/MyBitInputStream.java
@@ -70,7 +70,7 @@ public class MyBitInputStream extends FilterInputStream {
* Reads specified number of bits.
*
* @param sampleBits number of bits to read.
- * @return the bits as an integer.
+ * @return The bits as an integer.
* @throws IOException if I/O error occurs.
*/
public int readBits(final int sampleBits) throws IOException {
diff --git a/src/main/java/org/apache/commons/imaging/mylzw/MyLzwCompressor.java b/src/main/java/org/apache/commons/imaging/mylzw/MyLzwCompressor.java
index 95b55ab2..e3302c4a 100644
--- a/src/main/java/org/apache/commons/imaging/mylzw/MyLzwCompressor.java
+++ b/src/main/java/org/apache/commons/imaging/mylzw/MyLzwCompressor.java
@@ -230,7 +230,7 @@ public class MyLzwCompressor {
* Compresses data using LZW compression.
*
* @param bytes the bytes to compress.
- * @return the compressed bytes.
+ * @return The compressed bytes.
* @throws IOException if an I/O error occurs.
*/
public byte[] compress(final byte[] bytes) throws IOException {
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 238c5a9a..a284f12a 100644
--- a/src/main/java/org/apache/commons/imaging/palette/MedianCutQuantizer.java
+++ b/src/main/java/org/apache/commons/imaging/palette/MedianCutQuantizer.java
@@ -103,7 +103,7 @@ public class MedianCutQuantizer {
* @param image the image to process.
* @param maxColors the maximum number of colors in the palette.
* @param medianCut the median cut algorithm to use.
- * @return the generated palette.
+ * @return The generated palette.
* @throws ImagingException if an imaging error occurs.
*/
public Palette process(final BufferedImage image, final int maxColors, final MedianCut medianCut) throws ImagingException {
diff --git a/src/main/java/org/apache/commons/imaging/palette/Palette.java b/src/main/java/org/apache/commons/imaging/palette/Palette.java
index d987903c..f675161a 100644
--- a/src/main/java/org/apache/commons/imaging/palette/Palette.java
+++ b/src/main/java/org/apache/commons/imaging/palette/Palette.java
@@ -27,7 +27,7 @@ public interface Palette {
* Gets the color for a given palette index.
*
* @param index the palette index to look up
- * @return the color in ARGB format
+ * @return The color in ARGB format
*/
int getEntry(int index);
@@ -35,7 +35,7 @@ public interface Palette {
* Gets the palette index for a given color.
*
* @param rgb the color to look up
- * @return the palette index
+ * @return The palette index
* @throws ImagingException if it fails to read the palette index
*/
int getPaletteIndex(int rgb) throws ImagingException;
@@ -43,7 +43,7 @@ public interface Palette {
/**
* Gets the number of entries in the palette.
*
- * @return the number of palette entries
+ * @return The number of palette entries
*/
int length();
diff --git a/src/main/java/org/apache/commons/imaging/palette/PaletteFactory.java b/src/main/java/org/apache/commons/imaging/palette/PaletteFactory.java
index 22e78e03..6fad0268 100644
--- a/src/main/java/org/apache/commons/imaging/palette/PaletteFactory.java
+++ b/src/main/java/org/apache/commons/imaging/palette/PaletteFactory.java
@@ -363,7 +363,7 @@ public class PaletteFactory {
* {@linkplain #makeExactRgbPaletteSimple} for large images but uses 2 mebibytes of working memory. Treats all the colors as opaque.
*
* @param src the image whose palette to build
- * @return the palette
+ * @return The palette
*/
public Palette makeExactRgbPaletteFancy(final BufferedImage src) {
// map what rgb values have been used
@@ -420,7 +420,7 @@ public class PaletteFactory {
*
* @param src the image whose palette to build
* @param max the maximum number of colors the palette can contain
- * @return the complete palette of {@code max} or less colors, or {@code null} if more than {@code max} colors are necessary
+ * @return The complete palette of {@code max} or less colors, or {@code null} if more than {@code max} colors are necessary
*/
public SimplePalette makeExactRgbPaletteSimple(final BufferedImage src, final int max) {
// This is not efficient for large values of max, say, max > 256;
@@ -458,7 +458,7 @@ public class PaletteFactory {
* @param src the image whose palette to build
* @param transparent whether to consider the alpha values
* @param max the maximum number of colors the palette can contain
- * @return the palette of at most {@code max} colors
+ * @return The palette of at most {@code max} colors
* @throws ImagingException if it fails to process the palette
*/
public Palette makeQuantizedRgbaPalette(final BufferedImage src, final boolean transparent, final int max) throws ImagingException {
@@ -472,7 +472,7 @@ public class PaletteFactory {
*
* @param src the image whose palette to build
* @param max the maximum number of colors the palette can contain
- * @return the palette of at most {@code max} colors
+ * @return The palette of at most {@code max} colors
*/
public Palette makeQuantizedRgbPalette(final BufferedImage src, final int max) {
final int precision = 6; // in bits
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 976c5aed..eb062feb 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
@@ -396,7 +396,7 @@ public class SurveyTiffFile {
* Trims spaces from a range of characters intended for a CSV output
*
* @param source the standard source file
- * @return the equivalent string with spaces removed.
+ * @return The equivalent string with spaces removed.
*/
private String trimForCsv(final StringBuilder source) {
int n = source.length();
diff --git a/src/test/java/org/apache/commons/imaging/formats/tiff/TiffReadImageInfoTest.java b/src/test/java/org/apache/commons/imaging/formats/tiff/TiffReadImageInfoTest.java
index 59568747..1d8bd5c6 100644
--- a/src/test/java/org/apache/commons/imaging/formats/tiff/TiffReadImageInfoTest.java
+++ b/src/test/java/org/apache/commons/imaging/formats/tiff/TiffReadImageInfoTest.java
@@ -50,7 +50,7 @@ class TiffReadImageInfoTest extends AbstractTiffTest {
*
* @param info a valid instance obtained from TiffImageParser
* @param target the target data field string
- * @return the value
+ * @return The value
*/
private String getValue(final ImageInfo info, final String target) {
final String s = info.toString();