aboutsummaryrefslogtreecommitdiff
path: root/src/ui/about.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/about.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/about.h')
-rw-r--r--src/ui/about.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/ui/about.h b/src/ui/about.h
index 86e7fe0..e96641a 100644
--- a/src/ui/about.h
+++ b/src/ui/about.h
@@ -35,10 +35,23 @@ typedef struct UI_ABOUT_Handle
35 GtkButton *close_button; 35 GtkButton *close_button;
36} UI_ABOUT_Handle; 36} UI_ABOUT_Handle;
37 37
38/**
39 * Initializes a handle for the about dialog of
40 * a given messenger application.
41 *
42 * @param app Messenger application
43 * @param handle About dialog handle
44 */
38void 45void
39ui_about_dialog_init(MESSENGER_Application *app, 46ui_about_dialog_init(MESSENGER_Application *app,
40 UI_ABOUT_Handle *handle); 47 UI_ABOUT_Handle *handle);
41 48
49/**
50 * Cleans up the allocated resources and resets the
51 * state of a given about dialog handle.
52 *
53 * @param handle About dialog handle
54 */
42void 55void
43ui_about_dialog_cleanup(UI_ABOUT_Handle *handle); 56ui_about_dialog_cleanup(UI_ABOUT_Handle *handle);
44 57