[gnome-software/1587-updates-glitchy-empty-list: 18/21] gs-app-row: Add comment for gs_app_row_unreveal()

[Milan Crha <mcrha src gnome org>]

commit 3aad80cfe8e949064ccd343ac2c95b342ab7ef1a
Author: Milan Crha <mcrha redhat com>
Date:   Thu Aug 25 08:00:26 2022 +0200

    gs-app-row: Add comment for gs_app_row_unreveal()

 src/gs-app-row.c | 13 +++++++++++++
 1 file changed, 13 insertions(+)
---
diff --git a/src/gs-app-row.c b/src/gs-app-row.c
index b318c97a2..a1eff88a6 100644
--- a/src/gs-app-row.c
+++ b/src/gs-app-row.c
@@ -575,6 +575,19 @@ child_unrevealed_unmapped_cb (gpointer user_data)
        return G_SOURCE_REMOVE;
 }
 
+/**
+ * gs_app_row_unreveal:
+ * @app_row: a #GsAppRow
+ *
+ * Hide the row with an animation. Once the animation is done
+ * the GsAppRow:unrevealed signal is emitted. This handles
+ * the case when the widget is not mapped as well, in which case
+ * the GsAppRow:unrevealed signal is emitted from an idle
+ * callback, to ensure async nature of the function call and
+ * the signal emission.
+ *
+ * Calling the function multiple times has no effect.
+ **/
 void
 gs_app_row_unreveal (GsAppRow *app_row)
 {