docs: Documented the rest of the classes

Author: Enginecrafter77

skeletonlayoutng/src/main/java/dev/enginecrafter77/skeletonlayoutng/DefaultSkeletonFactory.java

@@ -6,6 +6,12 @@
 import androidx.annotation.LayoutRes;
 import androidx.recyclerview.widget.RecyclerView;
 
+/**
+ * A static facade for {@link SkeletonFactory#getDefault()}.
+ * Any static call {@code DefaultSkeletonFactory.XYZ()} is equivalent to calling {@code SkeletonFactory.getDefault().XYZ()}.
+ * Mostly used for convenience.
+ * @author Enginecrafter77
+ */
 public class DefaultSkeletonFactory {
 	public static DetachableSkeleton createSkeleton(View view)
 	{

skeletonlayoutng/src/main/java/dev/enginecrafter77/skeletonlayoutng/DetachableSkeleton.java

@@ -16,6 +16,21 @@
  */
 package dev.enginecrafter77.skeletonlayoutng;
 
+/**
+ * DetachableSkeleton is a simple extension to {@link Skeleton} allowing it to be completely
+ * uninstalled from the associated element.
+ * @author Enginecrafter77
+ */
 public interface DetachableSkeleton extends Skeleton {
+	/**
+	 * <p>Detaches the skeleton from the associated element.</p>
+	 *
+	 * <p>
+	 *     Upon call to this method, {@link #showSkeleton()} and {@link #hideSkeleton()} methods
+	 *     should become NO-OP, and the result of {@link #isActive()} becomes undefined.
+	 * </p>
+	 *
+	 * <p>This method is idempotent. Subsequent calls to this method should be NO-OP.</p>
+	 */
 	public void detachSkeleton();
 }

skeletonlayoutng/src/main/java/dev/enginecrafter77/skeletonlayoutng/RecyclerViewSkeleton.java

@@ -22,6 +22,18 @@
 import androidx.annotation.Nullable;
 import androidx.recyclerview.widget.RecyclerView;
 
+/**
+ * <p>
+ *     RecyclerViewSkeleton is a {@link Skeleton} implementation forattaching {@link SkeletonAdapter} to a recyclerview
+ *     in accordance with the Skeleton behavior.
+ * </p>
+ *
+ * <p>
+ *     RecyclerViewSkeleton makes sure that when activating the skeleton, no state is lost. The original adapter is
+ *     still remembered, and upon hiding the skeleton the suppressed adapter is restored.
+ * </p>
+ * @author Enginecrafter77
+ */
 public class RecyclerViewSkeleton implements Skeleton {
 	private final RecyclerView view;
 	private final SkeletonAdapter skeletonAdapter;

skeletonlayoutng/src/main/java/dev/enginecrafter77/skeletonlayoutng/SkeletonAdapter.java

@@ -29,6 +29,10 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * SkeletonAdapter is a {@link RecyclerView.Adapter} implementation that displays skeleton children in the RecyclerView.
+ * @author Enginecrafter77
+ */
 public class SkeletonAdapter extends RecyclerView.Adapter<SkeletonAdapter.SkeletonItem> {
 	private final SkeletonFactory skeletonFactory;
 
@@ -40,6 +44,12 @@ public class SkeletonAdapter extends RecyclerView.Adapter<SkeletonAdapter.Skelet
 
 	private int itemCount;
 
+	/**
+	 * Create a SkeletonAdapter using the given parameters.
+	 * @param itemLayout The layout resource for children
+	 * @param itemSkeletons The item IDs in the child layout that should be made into skeletons
+	 * @param skeletonFactory The skeleton factory used to make the child skeletons
+	 */
 	public SkeletonAdapter(@LayoutRes int itemLayout, @IdRes int[] itemSkeletons, SkeletonFactory skeletonFactory)
 	{
 		this.skeletonFactory = skeletonFactory;

skeletonlayoutng/src/main/java/dev/enginecrafter77/skeletonlayoutng/SkeletonDrawable.java

@@ -34,6 +34,18 @@
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 
+/**
+ * <p>SkeletonDrawable is the main means of displaying skeletons.</p>
+ *
+ * <p>
+ *     SkeletonDrawable takes the form of a simple strip with a running shimmer animation covering the whole element bounds.
+ * </p>
+ *
+ * <p>
+ *     SkeletonDrawable can be configured by using {@link #setStyle(SkeletonStyle)}.
+ * </p>
+ * @author Enginecrafter77
+ */
 public class SkeletonDrawable extends Drawable implements Skeleton {
 	private final Matrix shimmerBoundMatrix;
 	private final Matrix shimmerOutMatrix;

skeletonlayoutng/src/main/java/dev/enginecrafter77/skeletonlayoutng/SkeletonFactory.java

@@ -27,6 +27,15 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+/**
+ * <p>SkeletonFactory is a class that creates skeletons for various elements (maily Views).</p>
+ *
+ * <p>
+ *     The main goal of an abstract SkeletonFactory is that it can be supplied with user-specified {@link SkeletonStyle},
+ *     which is subsequently passed down onto the children (as is case in {@link SkeletonAdapter} for example).
+ * </p>
+ * @author Enginecrafter77
+ */
 public class SkeletonFactory {
 	@Nullable
 	private final SkeletonStyle style;

skeletonlayoutng/src/main/java/dev/enginecrafter77/skeletonlayoutng/SkeletonGroup.java

@@ -18,37 +18,33 @@
 
 import com.google.common.collect.ImmutableSet;
 
+/**
+ * <p>
+ *     SkeletonGroup is a {@link Skeleton} implementation that is used to
+ *     synchronize the Skeleton behavior of one or more other skeleton instances.
+ * </p>
+ *
+ * <p>
+ *     As is case with other Skeleton implementations, upon group formation the
+ *     state of its constituents is undefined, and therefore the state of the
+ *     whole group is undefined as well. The value returned by {@link #isActive()}
+ *     should not be relied upon. Only after a call to {@link #showSkeleton()}
+ *     or {@link #hideSkeleton()} can the state be considered defined, and {@link #isActive()}
+ *     will return the expected result.
+ * </p>
+ * @author Enginecrafter77
+ */
 public class SkeletonGroup implements Skeleton {
 	private final ImmutableSet<Skeleton> skeletons;
 
 	private boolean active;
 
-	protected SkeletonGroup(ImmutableSet<Skeleton> skeletons)
+	public SkeletonGroup(ImmutableSet<Skeleton> skeletons)
 	{
 		this.skeletons = skeletons;
 		this.active = false;
 	}
 
-	protected void sync()
-	{
-		int numActive = 0;
-		int numInactive = 0;
-
-		for(Skeleton member : this.skeletons)
-		{
-			if(member.isActive())
-				++numActive;
-			else
-				++numInactive;
-		}
-
-		boolean active = numActive >= numInactive;
-		if(active)
-			this.showSkeleton();
-		else
-			this.hideSkeleton();
-	}
-
 	@Override
 	public boolean isActive()
 	{
@@ -73,9 +69,7 @@ public void hideSkeleton()
 
 	public static SkeletonGroup create(Iterable<Skeleton> skeletons)
 	{
-		SkeletonGroup group = new SkeletonGroup(ImmutableSet.copyOf(skeletons));
-		group.sync();
-		return group;
+		return new SkeletonGroup(ImmutableSet.copyOf(skeletons));
 	}
 
 	public static SkeletonGroup create(Skeleton... skeletons)

skeletonlayoutng/src/main/java/dev/enginecrafter77/skeletonlayoutng/SkeletonLayout.java

@@ -24,6 +24,20 @@
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 
+/**
+ * <p>SkeletonLayout is a simple {@link FrameLayout} with an implicitly constructed {@link Skeleton}.</p>
+ *
+ * <p>
+ *     SkeletonLayout can be used as an XML-explicit declaration of skeleton covering a view. This instance
+ *     can then directly be used to control the skeleton covering the view.
+ * </p>
+ *
+ * <p>
+ *     Upon construction, the skeleton state is undefined. Therefore, it is advised to call either
+ *     {@link #showSkeleton()} or {@link #hideSkeleton()} before the view gets displayed.
+ * </p>
+ * @author Enginecrafter77
+ */
 public class SkeletonLayout extends FrameLayout implements Skeleton {
 	private final SkeletonDrawable skeletonDrawable;
 

skeletonlayoutng/src/main/java/dev/enginecrafter77/skeletonlayoutng/SkeletonOverlay.java

@@ -25,17 +25,24 @@ public class SkeletonOverlay extends SkeletonDrawable implements DetachableSkele
 
 	private final View view;
 
+	private boolean installed;
+
 	public SkeletonOverlay(View view)
 	{
 		super();
 		this.view = view;
 		this.onLayoutChangeListener = this::onViewLayoutChange;
+		this.installed = false;
 	}
 
-	protected void install()
+	protected synchronized void install()
 	{
+		if(this.installed)
+			return;
+
 		this.view.getOverlay().add(this);
 		this.view.addOnLayoutChangeListener(this.onLayoutChangeListener);
+		this.installed = true;
 	}
 
 	@UiThread
@@ -45,9 +52,13 @@ protected void onViewLayoutChange(View view, int left, int top, int right, int b
 	}
 
 	@Override
-	public void detachSkeleton()
+	public synchronized void detachSkeleton()
 	{
+		if(!this.installed)
+			return;
+
 		this.view.getOverlay().remove(this);
 		this.view.removeOnLayoutChangeListener(this.onLayoutChangeListener);
+		this.installed = false;
 	}
 }

skeletonlayoutng/src/main/java/dev/enginecrafter77/skeletonlayoutng/SkeletonStyle.java

@@ -25,19 +25,35 @@
 
 import java.util.Objects;
 
+/**
+ * SkeletonStyle is an immutable object that controls the appearance of {@link SkeletonDrawable}.
+ * @author Enginecrafter77
+ */
 public class SkeletonStyle {
 	public static final SkeletonStyle DEFAULT = new SkeletonStyle(0xFFE0E0E0, 0xFFD5D5D5, 5F, 8F, 1500);
 
+	/** The color the strip will be filled with */
 	@ColorInt
 	public final int fillColor;
 
+	/** The color of the running shimmer. Should normally be only slightly different from {@link #fillColor} */
 	@ColorInt
 	public final int shimmerColor;
 
+	/**
+	 * The angle (in degrees) the shimmer should be tilted in counter-clockwise direction.
+	 * Angle o 0deg describes perfect left-to-right shimmer, 90deg makes it go from bottom to top.
+	 * It is not advised to use angles in excess of 45deg as that can produce undesirable visual effects.
+	 */
 	public final float shimmerAngle;
 
+	/** The radius of skeleton strip borders in partial pixels. */
 	public final float borderRadius;
 
+	/**
+	 * The duration of 1 iteration of the shimmer animation.
+	 * The shimmer animation will spend 2/7 of that time running, and the rest dwelling.
+	 */
 	public final int shimmerPeriodMs;
 
 	public SkeletonStyle(int fillColor, int shimmerColor, float shimmerAngle, float borderRadius, int shimmerPeriodMs)