From 8f53a6e879f360e80941cb6e9d502d7522bbeeba Mon Sep 17 00:00:00 2001 From: TheJackiMonster Date: Sat, 23 Apr 2022 19:13:29 +0200 Subject: Added doxygen comments to all functions in the headers Signed-off-by: TheJackiMonster --- src/ui/delete_messages.h | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'src/ui/delete_messages.h') diff --git a/src/ui/delete_messages.h b/src/ui/delete_messages.h index b0c04e0..4f5474c 100644 --- a/src/ui/delete_messages.h +++ b/src/ui/delete_messages.h @@ -50,15 +50,37 @@ typedef struct UI_DELETE_MESSAGES_Handle GtkButton *confirm_button; } UI_DELETE_MESSAGES_Handle; +/** + * Initializes a handle for the delete messages + * dialog of a given messenger application. + * + * @param app Messenger application + * @param handle Delete messages dialog handle + */ void ui_delete_messages_dialog_init(MESSENGER_Application *app, UI_DELETE_MESSAGES_Handle *handle); +/** + * Links a custom list and a callback to a + * given delete messages dialog which will be + * used to handle the event of deletion. + * + * @param handle Delete messages dialog handle + * @param callback Delete messages callback + * @param selected Selected messages + */ void ui_delete_messages_dialog_link(UI_DELETE_MESSAGES_Handle *handle, UI_DELETE_MESSAGES_Callback callback, GList *selected); +/** + * Cleans up the allocated resources and resets the + * state of a given delete messages dialog handle. + * + * @param handle Delete messages dialog handle + */ void ui_delete_messages_dialog_cleanup(UI_DELETE_MESSAGES_Handle *handle); -- cgit v1.2.3