Improved code readability
authorSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Fri, 14 Jul 2023 04:08:51 +0000 (07:08 +0300)
committerSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Fri, 14 Jul 2023 04:08:51 +0000 (07:08 +0300)
src/main/java/eu/svjatoslav/sixth/e3d/renderer/raster/Color.java

index a78192d..0743cf0 100644 (file)
@@ -15,13 +15,25 @@ public final class Color {
     public static final Color PURPLE = new Color(255, 0, 255, 255);
     public static final Color TRANSPARENT = new Color(0, 0, 0, 0);
 
-    public final int r, g, b;
+    /**
+     * Red component. 0-255.
+     */
+    public final int r;
+
+    /**
+     * Green component. 0-255.
+     */
+    public final int g;
+
+    /**
+     * Blue component. 0-255.
+     */
+    public final int b;
 
     /**
-     * <pre>
-     * 255 is opaque.
-     * 0 is transparent.
-     * </pre>
+     * Alpha component.
+     * 0 - transparent.
+     * 255 - opaque.
      */
     public int a;
 
@@ -40,14 +52,14 @@ public final class Color {
     }
 
     /**
-     * <pre>
-     *     Supported formats are:
-     *
-     *     RGB
-     *     RGBA
-     *     RRGGBB
-     *     RRGGBBAA
-     * </pre>
+     * @param colorHexCode color code in hex format.
+     *                     Supported formats are:
+     *                     <pre>
+     *                     RGB
+     *                     RGBA
+     *                     RRGGBB
+     *                     RRGGBBAA
+     *                     </pre>
      */
     public Color(String colorHexCode) {
         switch (colorHexCode.length()) {