aboutsummaryrefslogtreecommitdiff
path: root/src/ui/contacts.h
diff options
context:
space:
mode:
authorTheJackiMonster <thejackimonster@gmail.com>2022-04-23 19:13:29 +0200
committerTheJackiMonster <thejackimonster@gmail.com>2022-04-23 19:13:29 +0200
commit8f53a6e879f360e80941cb6e9d502d7522bbeeba (patch)
tree272195e4de223342ed88a69cc20137f9b0440da2 /src/ui/contacts.h
parentfc56c6148f22d363a27c7a39d8d97a2d4d908a92 (diff)
downloadmessenger-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/contacts.h')
-rw-r--r--src/ui/contacts.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/ui/contacts.h b/src/ui/contacts.h
index 6bb3475..f63b554 100644
--- a/src/ui/contacts.h
+++ b/src/ui/contacts.h
@@ -39,10 +39,23 @@ typedef struct UI_CONTACTS_Handle
39 GtkButton *close_button; 39 GtkButton *close_button;
40} UI_CONTACTS_Handle; 40} UI_CONTACTS_Handle;
41 41
42/**
43 * Initializes a handle for the contacts dialog
44 * of a given messenger application.
45 *
46 * @param app Messenger application
47 * @param handle Contacts dialog handle
48 */
42void 49void
43ui_contacts_dialog_init(MESSENGER_Application *app, 50ui_contacts_dialog_init(MESSENGER_Application *app,
44 UI_CONTACTS_Handle *handle); 51 UI_CONTACTS_Handle *handle);
45 52
53/**
54 * Cleans up the allocated resources and resets the
55 * state of a given contacts dialog handle.
56 *
57 * @param handle Contacts dialog handle
58 */
46void 59void
47ui_contacts_dialog_cleanup(UI_CONTACTS_Handle *handle); 60ui_contacts_dialog_cleanup(UI_CONTACTS_Handle *handle);
48 61