aboutsummaryrefslogtreecommitdiff
path: root/src/ui/accounts.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/accounts.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/accounts.h')
-rw-r--r--src/ui/accounts.h20
1 files changed, 20 insertions, 0 deletions
diff --git a/src/ui/accounts.h b/src/ui/accounts.h
index a71e31e..9bfedff 100644
--- a/src/ui/accounts.h
+++ b/src/ui/accounts.h
@@ -39,14 +39,34 @@ typedef struct UI_ACCOUNTS_Handle
39 GtkButton *close_button; 39 GtkButton *close_button;
40} UI_ACCOUNTS_Handle; 40} UI_ACCOUNTS_Handle;
41 41
42/**
43 * Initializes a handle for the accounts dialog
44 * of a given messenger application.
45 *
46 * @param app Messenger application
47 * @param handle Accounts dialog handle
48 */
42void 49void
43ui_accounts_dialog_init(MESSENGER_Application *app, 50ui_accounts_dialog_init(MESSENGER_Application *app,
44 UI_ACCOUNTS_Handle *handle); 51 UI_ACCOUNTS_Handle *handle);
45 52
53/**
54 * Refreshes a given accounts dialog handle with the
55 * current list of accounts from a messenger application.
56 *
57 * @param app Messenger application
58 * @param handle Accounts dialog handle
59 */
46void 60void
47ui_accounts_dialog_refresh(MESSENGER_Application *app, 61ui_accounts_dialog_refresh(MESSENGER_Application *app,
48 UI_ACCOUNTS_Handle *handle); 62 UI_ACCOUNTS_Handle *handle);
49 63
64/**
65 * Cleans up the allocated resources and resets the
66 * state of a given accounts dialog handle.
67 *
68 * @param handle Accounts dialog handle
69 */
50void 70void
51ui_accounts_dialog_cleanup(UI_ACCOUNTS_Handle *handle); 71ui_accounts_dialog_cleanup(UI_ACCOUNTS_Handle *handle);
52 72