diff options
author | TheJackiMonster <thejackimonster@gmail.com> | 2022-04-23 19:13:29 +0200 |
---|---|---|
committer | TheJackiMonster <thejackimonster@gmail.com> | 2022-04-23 19:13:29 +0200 |
commit | 8f53a6e879f360e80941cb6e9d502d7522bbeeba (patch) | |
tree | 272195e4de223342ed88a69cc20137f9b0440da2 /src/ui/delete_messages.h | |
parent | fc56c6148f22d363a27c7a39d8d97a2d4d908a92 (diff) | |
download | messenger-gtk-8f53a6e879f360e80941cb6e9d502d7522bbeeba.tar.gz messenger-gtk-8f53a6e879f360e80941cb6e9d502d7522bbeeba.zip |
Added doxygen comments to all functions in the headers
Signed-off-by: TheJackiMonster <thejackimonster@gmail.com>
Diffstat (limited to 'src/ui/delete_messages.h')
-rw-r--r-- | src/ui/delete_messages.h | 22 |
1 files changed, 22 insertions, 0 deletions
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 | |||
50 | GtkButton *confirm_button; | 50 | GtkButton *confirm_button; |
51 | } UI_DELETE_MESSAGES_Handle; | 51 | } UI_DELETE_MESSAGES_Handle; |
52 | 52 | ||
53 | /** | ||
54 | * Initializes a handle for the delete messages | ||
55 | * dialog of a given messenger application. | ||
56 | * | ||
57 | * @param app Messenger application | ||
58 | * @param handle Delete messages dialog handle | ||
59 | */ | ||
53 | void | 60 | void |
54 | ui_delete_messages_dialog_init(MESSENGER_Application *app, | 61 | ui_delete_messages_dialog_init(MESSENGER_Application *app, |
55 | UI_DELETE_MESSAGES_Handle *handle); | 62 | UI_DELETE_MESSAGES_Handle *handle); |
56 | 63 | ||
64 | /** | ||
65 | * Links a custom list and a callback to a | ||
66 | * given delete messages dialog which will be | ||
67 | * used to handle the event of deletion. | ||
68 | * | ||
69 | * @param handle Delete messages dialog handle | ||
70 | * @param callback Delete messages callback | ||
71 | * @param selected Selected messages | ||
72 | */ | ||
57 | void | 73 | void |
58 | ui_delete_messages_dialog_link(UI_DELETE_MESSAGES_Handle *handle, | 74 | ui_delete_messages_dialog_link(UI_DELETE_MESSAGES_Handle *handle, |
59 | UI_DELETE_MESSAGES_Callback callback, | 75 | UI_DELETE_MESSAGES_Callback callback, |
60 | GList *selected); | 76 | GList *selected); |
61 | 77 | ||
78 | /** | ||
79 | * Cleans up the allocated resources and resets the | ||
80 | * state of a given delete messages dialog handle. | ||
81 | * | ||
82 | * @param handle Delete messages dialog handle | ||
83 | */ | ||
62 | void | 84 | void |
63 | ui_delete_messages_dialog_cleanup(UI_DELETE_MESSAGES_Handle *handle); | 85 | ui_delete_messages_dialog_cleanup(UI_DELETE_MESSAGES_Handle *handle); |
64 | 86 | ||