Add javadoc for color classes in kernel

DEVSIX-8138

Author: nanouh

kernel/src/main/java/com/itextpdf/kernel/colors/CalGray.java

@@ -24,21 +24,49 @@ This file is part of the iText (R) project.
 
 import com.itextpdf.kernel.pdf.colorspace.PdfCieBasedCs;
 
+/**
+ * Representation of a CalGray color space.
+ */
 public class CalGray extends Color {
 
 
+    /**
+     * Creates a new CalGray color space using the given {@link PdfCieBasedCs} color space.
+     *
+     * @param cs Color space
+     */
     public CalGray(PdfCieBasedCs.CalGray cs) {
         this(cs, 0f);
     }
 
+    /**
+     * Creates a new CalGray color space using the given {@link PdfCieBasedCs} color space and color value.
+     *
+     * @param cs    Color space
+     * @param value Gray color value
+     */
     public CalGray(PdfCieBasedCs.CalGray cs, float value) {
         super(cs, new float[]{value});
     }
 
+    /**
+     * Creates a new CalGray color space using the given white point and color value.
+     *
+     * @param whitePoint Color values for defining the white point
+     * @param value      Gray color value
+     */
     public CalGray(float[] whitePoint, float value) {
         super(new PdfCieBasedCs.CalGray(whitePoint), new float[]{value});
     }
 
+    /**
+     * Creates a new CalGray color space using the given white point, black point, gamma and color value.
+     *
+     * @param whitePoint Color values for defining the white point
+     * @param blackPoint Color values for defining the black point
+     * @param gamma      Gamma correction
+     * @param value      Gray color value
+     */
     public CalGray(float[] whitePoint, float[] blackPoint, float gamma, float value) {
         this(new PdfCieBasedCs.CalGray(whitePoint, blackPoint, gamma), value);
     }

kernel/src/main/java/com/itextpdf/kernel/colors/CalRgb.java

@@ -24,21 +24,50 @@ This file is part of the iText (R) project.
 
 import com.itextpdf.kernel.pdf.colorspace.PdfCieBasedCs;
 
+/**
+ * Representation of a CalRgb color space.
+ */
 public class CalRgb extends Color {
 
 
+    /**
+     * Creates a new CalRgb color using the given {@link PdfCieBasedCs} color space.
+     *
+     * @param cs Color space
+     */
     public CalRgb(PdfCieBasedCs.CalRgb cs) {
         this(cs, new float[cs.getNumberOfComponents()]);
     }
 
+    /**
+     * Creates a new CalRgb color using the given {@link PdfCieBasedCs} color space and RGB color values.
+     *
+     * @param cs    Color space
+     * @param value RGB color values
+     */
     public CalRgb(PdfCieBasedCs.CalRgb cs, float[] value) {
         super(cs, value);
     }
 
+    /**
+     * Creates a new CalRgb color using the given white point and RGB color values.
+     *
+     * @param whitePoint Color values for defining the white point
+     * @param value      RGB color values
+     */
     public CalRgb(float[] whitePoint, float[] value) {
         super(new PdfCieBasedCs.CalRgb(whitePoint), value);
     }
 
+    /**
+     * Creates a new CalRgb color using the given white point, black point, gamma, matrix and RGB color values.
+     *
+     * @param whitePoint Color values for defining the white point
+     * @param blackPoint Color values for defining the black point
+     * @param gamma      Gamma correction
+     * @param matrix     Matrix correction
+     * @param value      RGB color value
+     */
     public CalRgb(float[] whitePoint, float[] blackPoint, float[] gamma, float[] matrix, float[] value) {
         this(new PdfCieBasedCs.CalRgb(whitePoint, blackPoint, gamma, matrix), value);
     }

kernel/src/main/java/com/itextpdf/kernel/colors/DeviceN.java

@@ -29,24 +29,38 @@ This file is part of the iText (R) project.
 import java.util.Arrays;
 import java.util.List;
 
+/**
+ * Representation of a DeviceN color space.
+ */
 public class DeviceN extends Color {
 
 
+    /**
+     * Creates a DeviceN color using the given {@link PdfSpecialCs} color space.
+     *
+     * @param cs Color space
+     */
     public DeviceN(PdfSpecialCs.DeviceN cs) {
         this(cs, getDefaultColorants(cs.getNumberOfComponents()));
     }
 
+    /**
+     * Creates a DeviceN color using the given {@link PdfSpecialCs} color space and color values.
+     *
+     * @param cs    Color space
+     * @param value Color component values
+     */
     public DeviceN(PdfSpecialCs.DeviceN cs, float[] value) {
         super(cs, value);
     }
 
     /**
      * Creates a color in a new DeviceN color space.
      *
-     * @param names the names oif the components
-     * @param alternateCs the alternate color space
+     * @param names         the names oif the components
+     * @param alternateCs   the alternate color space
      * @param tintTransform the function to transform color to the alternate color space
-     * @param value the values for the components of this color
+     * @param value         the values for the components of this color
      */
     public DeviceN(List<String> names, PdfColorSpace alternateCs, IPdfFunction tintTransform, float[] value) {
         this(new PdfSpecialCs.DeviceN(names, alternateCs, tintTransform), value);

kernel/src/main/java/com/itextpdf/kernel/colors/IccBased.java

@@ -28,13 +28,27 @@ This file is part of the iText (R) project.
 
 import java.io.InputStream;
 
+/**
+ * Representation on an ICC Based color space.
+ */
 public class IccBased extends Color {
 
 
+    /**
+     * Creates an ICC Based color using the given {@link PdfCieBasedCs} color space.
+     *
+     * @param cs Color space
+     */
     public IccBased(PdfCieBasedCs.IccBased cs) {
         this(cs, new float[cs.getNumberOfComponents()]);
     }
 
+    /**
+     * Creates an ICC Based color using the given {@link PdfCieBasedCs} color space and color values.
+     *
+     * @param cs    Color space
+     * @param value Color values
+     */
     public IccBased(PdfCieBasedCs.IccBased cs, float[] value) {
         super(cs, value);
     }
@@ -61,6 +75,13 @@ public IccBased(InputStream iccStream, float[] value) {
         this(new PdfCieBasedCs.IccBased(iccStream), value);
     }
 
+    /**
+     * Creates an ICC Based color using the given ICC profile stream, range and color values.
+     *
+     * @param iccStream ICC profile stream. User is responsible for closing the stream.
+     * @param range     Range for color
+     * @param value     Color values
+     */
     public IccBased(InputStream iccStream, float[] range, float[] value) {
         this(new PdfCieBasedCs.IccBased(iccStream, range), value);
         if (getNumberOfComponents() * 2 != range.length)

kernel/src/main/java/com/itextpdf/kernel/colors/Indexed.java

@@ -24,13 +24,26 @@ This file is part of the iText (R) project.
 
 import com.itextpdf.kernel.pdf.colorspace.PdfColorSpace;
 
+/**
+ * Representation of an indexed color space.
+ */
 public class Indexed extends Color {
 
-
+    /**
+     * Creates an indexed color using the given {@link PdfColorSpace}.
+     *
+     * @param colorSpace Object containing the most common properties of color spaces
+     */
     public Indexed(PdfColorSpace colorSpace) {
         this(colorSpace, 0);
     }
 
+    /**
+     * Creates an indexed color using the given {@link PdfColorSpace} and color values.
+     *
+     * @param colorSpace Object containing the most common properties of color spaces
+     * @param colorValue Color values
+     */
     public Indexed(PdfColorSpace colorSpace, int colorValue) {
         super(colorSpace, new float[] {colorValue});
     }

kernel/src/main/java/com/itextpdf/kernel/colors/Lab.java

@@ -24,21 +24,49 @@ This file is part of the iText (R) project.
 
 import com.itextpdf.kernel.pdf.colorspace.PdfCieBasedCs;
 
+/**
+ * Representation of a lab color space.
+ */
 public class Lab extends Color {
 
 
+    /**
+     * Creates a lab color using the given {@link PdfCieBasedCs} color space.
+     *
+     * @param cs Color space
+     */
     public Lab(PdfCieBasedCs.Lab cs) {
         this(cs, new float[cs.getNumberOfComponents()]);
     }
 
+    /**
+     * Creates a lab color using the given {@link PdfCieBasedCs} color space and color values.
+     *
+     * @param cs    Color space
+     * @param value Color values
+     */
     public Lab(PdfCieBasedCs.Lab cs, float[] value) {
         super(cs, value);
     }
 
+    /**
+     * Creates a lab color using the given white point and color values.
+     *
+     * @param whitePoint Color values for defining the white point
+     * @param value      Color values
+     */
     public Lab(float[] whitePoint, float[] value) {
         super(new PdfCieBasedCs.Lab(whitePoint), value);
     }
 
+    /**
+     * Creates a lab color using the given white point, black point and color values.
+     *
+     * @param whitePoint Color values for defining the white point
+     * @param blackPoint Color values for defining the black point
+     * @param range      Range for color
+     * @param value      Color values
+     */
     public Lab(float[] whitePoint, float[] blackPoint, float[] range, float[] value) {
         this(new PdfCieBasedCs.Lab(whitePoint, blackPoint, range), value);
     }

kernel/src/main/java/com/itextpdf/kernel/colors/PatternColor.java

@@ -26,31 +26,64 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.colorspace.PdfPattern;
 import com.itextpdf.kernel.pdf.colorspace.PdfSpecialCs;
 
+/**
+ * Representation of a Pattern Color.
+ */
 public class PatternColor extends Color {
 
     private PdfPattern pattern;
     // The underlying color for uncolored patterns. Will be null for colored ones.
     private Color underlyingColor;
 
+    /**
+     * Creates a pattern color using the given color pattern object.
+     *
+     * @param coloredPattern Color space that uses pattern objects
+     */
     public PatternColor(PdfPattern coloredPattern) {
         super(new PdfSpecialCs.Pattern(), null);
         this.pattern = coloredPattern;
     }
 
+    /**
+     * Creates a pattern color using the given uncolored pattern object and color.
+     *
+     * @param uncoloredPattern Tiling pattern object of the color space
+     * @param color            Color object
+     */
     public PatternColor(PdfPattern.Tiling uncoloredPattern, Color color) {
         this(uncoloredPattern, color.getColorSpace(), color.getColorValue());
     }
 
+    /**
+     * Creates a pattern color using the given uncolored pattern object, an underlying color space and color values.
+     *
+     * @param uncoloredPattern Tiling pattern object of the color space
+     * @param underlyingCS     Underlying color space object
+     * @param colorValue       Color values
+     */
     public PatternColor(PdfPattern.Tiling uncoloredPattern, PdfColorSpace underlyingCS, float[] colorValue) {
         this(uncoloredPattern, new PdfSpecialCs.UncoloredTilingPattern(ensureNotPatternCs(underlyingCS)), colorValue);
     }
 
+    /**
+     * Creates a pattern color using the given uncolored pattern object, uncolored tiling pattern and color values.
+     *
+     * @param uncoloredPattern  Tiling pattern object of the color space
+     * @param uncoloredTilingCS Tiling pattern color space
+     * @param colorValue        Color values
+     */
     public PatternColor(PdfPattern.Tiling uncoloredPattern, PdfSpecialCs.UncoloredTilingPattern uncoloredTilingCS, float[] colorValue) {
         super(uncoloredTilingCS, colorValue);
         this.pattern = uncoloredPattern;
         this.underlyingColor = makeColor(uncoloredTilingCS.getUnderlyingColorSpace(), colorValue);
     }
 
+    /**
+     * Returns the pattern of the color space.
+     *
+     * @return PdfPattern object
+     */
     public PdfPattern getPattern() {
         return pattern;
     }

kernel/src/main/java/com/itextpdf/kernel/colors/Separation.java

@@ -26,24 +26,38 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.colorspace.PdfSpecialCs;
 import com.itextpdf.kernel.pdf.function.IPdfFunction;
 
+/**
+ * Representation of a separation color space.
+ */
 public class Separation extends Color {
 
 
+    /**
+     * Creates a separation color using the given {@link PdfSpecialCs} color space.
+     *
+     * @param cs Color space
+     */
     public Separation(PdfSpecialCs.Separation cs) {
         this(cs, 1f);
     }
 
+    /**
+     * Creates a separation color using the given {@link PdfSpecialCs} color space and color value.
+     *
+     * @param cs    Color space
+     * @param value Color value
+     */
     public Separation(PdfSpecialCs.Separation cs, float value) {
         super(cs, new float[]{value});
     }
 
     /**
      * Creates a color in a new separation color space.
      *
-     * @param name the name for the separation color
-     * @param alternateCs the alternative color space
-     * @param tintTransform the function to transform color to the alternate colorspace
-     * @param value the color value
+     * @param name          the name for the separation color
+     * @param alternateCs   the alternative color space
+     * @param tintTransform the function to transform color to the alternate color space
+     * @param value         the color value
      */
     public Separation(String name, PdfColorSpace alternateCs, IPdfFunction tintTransform, float value) {
         this(new PdfSpecialCs.Separation(name, alternateCs, tintTransform), value);