[commons-imaging] branch master updated: Javadoc

[ggregory]

This is an automated email from the ASF dual-hosted git repository.

ggregory 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 a6ad1242 Javadoc
a6ad1242 is described below

commit a6ad12426db902cb840e2ffafaf3e31a60748754
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri Jun 2 08:47:08 2023 -0400

    Javadoc
---
 src/main/java/org/apache/commons/imaging/palette/Palette.java | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

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 f3a716b0..40fc2d93 100644
--- a/src/main/java/org/apache/commons/imaging/palette/Palette.java
+++ b/src/main/java/org/apache/commons/imaging/palette/Palette.java
@@ -24,15 +24,16 @@ import org.apache.commons.imaging.ImagingException;
 public interface Palette {
 
     /**
-     * Looks up the color for a given palette index.
+     * Gets the color for a given palette index.
+     *
      * @param index the palette index to look up
      * @return the color in ARGB format
      */
     int getEntry(int index);
 
-    // TODO: shouldn't it be an ImageReadException for getPaletteIndex?
     /**
-     * Looks up the palette index for a given color.
+     * Gets the palette index for a given color.
+     *
      * @param rgb the color to look up
      * @return the palette index
      * @throws ImagingException if it fails to read the palette index
@@ -40,7 +41,8 @@ public interface Palette {
     int getPaletteIndex(int rgb) throws ImagingException;
 
     /**
-     * The number of entries in the palette.
+     * Gets the number of entries in the palette.
+     *
      * @return the number of palette entries
      */
     int length();