messenger-gtk

commit d84938b3aba2404d58669b2518d3d134409c0f69
parent 156a0014caa6628f12f6743eba91b7245678e9c6
Author: Jacki <jacki@thejackimonster.de>
Date:   Sat, 10 Aug 2024 21:55:48 +0200

Add some doxygen comments

Signed-off-by: Jacki <jacki@thejackimonster.de>

Diffstat:
M
src/discourse.h
 | 
9
+++++++++

1 file changed, 9 insertions(+), 0 deletions(-)
diff --git a/src/discourse.h b/src/discourse.h
@@ -201,12 +201,21 @@ discourse_is_mute(const struct GNUNET_CHAT_Discourse *discourse);
  * @param contact Chat contact
  * @param container Container
  * @param linked Linking flag
+ * @return #TRUE if successful, #FALSE otherwise
  */
 gboolean
 discourse_link_widget(const struct GNUNET_CHAT_Discourse *discourse,
                       const struct GNUNET_CHAT_Contact *contact,
                       GtkContainer *container);
 
+/**
+ * Returns whether the data stream of a selected chat contact in 
+ * a given discourse is active or not.
+ *
+ * @param discourse Chat discourse
+ * @param contact Chat contact
+ * @return #TRUE if active, #FALSE otherwise
+ */
 gboolean
 discourse_is_active(const struct GNUNET_CHAT_Discourse *discourse,
                     const struct GNUNET_CHAT_Contact *contact);