From d4c6a433d71c3a1ad701da5e9970b5670bf5126c Mon Sep 17 00:00:00 2001 From: Alex Hart Date: Fri, 7 Jul 2023 10:40:40 -0300 Subject: [PATCH] Add documentation to DeliveryStatusView. --- .../securesms/components/DeliveryStatusView.java | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/app/src/main/java/org/thoughtcrime/securesms/components/DeliveryStatusView.java b/app/src/main/java/org/thoughtcrime/securesms/components/DeliveryStatusView.java index b37e10869a..11566879fb 100644 --- a/app/src/main/java/org/thoughtcrime/securesms/components/DeliveryStatusView.java +++ b/app/src/main/java/org/thoughtcrime/securesms/components/DeliveryStatusView.java @@ -18,6 +18,14 @@ import org.signal.core.util.DimensionUnit; import org.thoughtcrime.securesms.R; import org.thoughtcrime.securesms.util.ViewUtil; +/** + * View responsible for displaying the delivery status (NONE, PENDING, SENT, DELIVERED, READ) of a given outgoing message. + *

+ * This view manipulates its start / end padding to properly place the corresponding icon, and also performs a rotation + * animation on itself in the pending mode. Thus, users should be aware that padding values set in XML will be overwritten. + *

+ * If you need to control the horizontal spacing of this view, utilize margins instead. + */ public class DeliveryStatusView extends AppCompatImageView { private static final String STATE_KEY = "DeliveryStatusView.STATE";