messenger-gtk

commit 73095c3fcfd59636303d0de859f0fad003a5cd80
parent 001188aa407c6f6eecef0298d14a5fac3c7395e0
Author: Jacki <jacki@thejackimonster.de>
Date:   Mon, 12 Aug 2024 21:34:12 +0200

Add more doxygen comments

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

Diffstat:
M
src/application.h
 | 
12
++++++++++++
M
src/media.h
 | 
47
+++++++++++++++++++++++++++++++++++++++++++++++

2 files changed, 59 insertions(+), 0 deletions(-)
diff --git a/src/application.h b/src/application.h
@@ -291,9 +291,21 @@ application_call_message_event(MESSENGER_Application *app,
                                struct GNUNET_CHAT_Context *context,
                                const struct GNUNET_CHAT_Message *message);
 
+/**
+ * Lock the thread of the GNUnet scheduler
+ * until it gets unlocked again.
+ *
+ * @param app Messenger application
+ */
 void
 application_chat_lock(MESSENGER_Application *app);
 
+/**
+ * Unlock the thread of the GNUnet scheduler
+ * after being locked.
+ *
+ * @param app Messenger application
+ */
 void
 application_chat_unlock(MESSENGER_Application *app);
 
diff --git a/src/media.h b/src/media.h
@@ -57,25 +57,72 @@ typedef void
                                 const char *description,
                                 const char *role);
 
+/**
+ * Initialize a media info structure to list
+ * pipewire nodes related to a selected
+ * file descriptor or all available.
+ *
+ * @param media Media info
+ * @param app Messenger application
+ * @param fd File descriptor
+ */
 void
 media_pw_init(MESSENGER_MediaInfo *media,
               MESSENGER_Application *app,
               int fd);
 
+/**
+ * Initialize a media info structure to list
+ * pipewire nodes for each available camera
+ * device. 
+ *
+ * @param media Media info
+ * @param app Messenger application
+ */
 void
 media_init_camera_capturing(MESSENGER_MediaInfo *media,
                             MESSENGER_Application *app);
 
+/**
+ * Initialize a media info structure to list
+ * pipewire nodes for each available screencast
+ * option. 
+ *
+ * @param media Media info
+ * @param app Messenger application
+ */
 void
 media_init_screen_sharing(MESSENGER_MediaInfo *media,
                           MESSENGER_Application *app);
 
+/**
+ * Cleanup a media info structure with all
+ * its internal pipewire related resources.
+ *
+ * @param media Media info
+ */
 void
 media_pw_cleanup(MESSENGER_MediaInfo *media);
 
+/**
+ * Run the main loop from pipewire to get
+ * a current list of all nodes of a given
+ * media info.
+ *
+ * @param media Media info
+ */
 void
 media_pw_main_loop_run(MESSENGER_MediaInfo *media);
 
+/**
+ * Iterate all pipewire nodes of a given
+ * media info with its name, description
+ * and role.
+ *
+ * @param media Media info
+ * @param it Node iterator
+ * @param cls Closure
+ */
 void
 media_pw_iterate_nodes(MESSENGER_MediaInfo *media,
                        MESSENGER_MediaNodeIterator it,