Renamed HorizontalDividerItemDecoration to RecyclerViewDividerItemDecoration and improved the documentation comments in this class.

Author: adil-hussain-84

library/src/main/java/com/tazkiyatech/utils/views/HorizontalDividerItemDecoration.java renamed to library/src/main/java/com/tazkiyatech/utils/views/RecyclerViewDividerItemDecoration.java

@@ -5,17 +5,22 @@
 import android.graphics.drawable.Drawable;
 import android.view.View;
 
+import androidx.annotation.ColorInt;
 import androidx.annotation.NonNull;
 import androidx.recyclerview.widget.RecyclerView;
 
 /**
  * An extension of {@link RecyclerView.ItemDecoration} that
- * – when applied to a {@link RecyclerView} –
- * draws a horizontal divider at the bottom of each item in the {@link RecyclerView}.
+ * draws a divider between each item in a {@link RecyclerView}.
  * <p>
- * This class is a modification of N J's answer on Stack Overflow <a href="http://stackoverflow.com/a/31243174/1071320">here</a>.
+ * Unlike the {@link androidx.recyclerview.widget.DividerItemDecoration} class offered by the
+ * <a href="https://maven.google.com/web/index.html#androidx.recyclerview:recyclerview">recyclerview</a>
+ * library, this class does not draw the divider under the final item in the {@link RecyclerView}.
+ * <p>
+ * See <a href="https://stackoverflow.com/a/27037230/1071320">this answer</a> in Stack Overflow
+ * for a better understanding of {@link RecyclerView.ItemDecoration}.
  */
-public class HorizontalDividerItemDecoration extends RecyclerView.ItemDecoration {
+public class RecyclerViewDividerItemDecoration extends RecyclerView.ItemDecoration {
 
     private final Drawable dividerDrawable;
     private final int dividerHeightPixels;
@@ -25,15 +30,15 @@ public class HorizontalDividerItemDecoration extends RecyclerView.ItemDecoration
     /**
      * Constructor.
      *
-     * @param dividerColor             the color value to apply to the divider.
-     * @param dividerHeightPixels      the height to apply to the divider (in pixels).
-     * @param dividerMarginLeftPixels  the size of the left margin (in pixels).
-     * @param dividerMarginRightPixels the size of the right margin (in pixels).
+     * @param dividerColor             The color to apply to the divider.
+     * @param dividerHeightPixels      The height to apply to the divider (in pixels).
+     * @param dividerMarginLeftPixels  The left margin to apply to the divider (in pixels).
+     * @param dividerMarginRightPixels The right margin to apply to the divider (in pixels).
      */
-    public HorizontalDividerItemDecoration(int dividerColor,
-                                           int dividerHeightPixels,
-                                           int dividerMarginLeftPixels,
-                                           int dividerMarginRightPixels) {
+    public RecyclerViewDividerItemDecoration(@ColorInt int dividerColor,
+                                             int dividerHeightPixels,
+                                             int dividerMarginLeftPixels,
+                                             int dividerMarginRightPixels) {
         this.dividerDrawable = new ColorDrawable(dividerColor);
         this.dividerHeightPixels = dividerHeightPixels;
         this.dividerMarginLeftPixels = dividerMarginLeftPixels;