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/about.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/about.h')
-rw-r--r-- | src/ui/about.h | 13 |
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 | */ | ||
38 | void | 45 | void |
39 | ui_about_dialog_init(MESSENGER_Application *app, | 46 | ui_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 | */ | ||
42 | void | 55 | void |
43 | ui_about_dialog_cleanup(UI_ABOUT_Handle *handle); | 56 | ui_about_dialog_cleanup(UI_ABOUT_Handle *handle); |
44 | 57 | ||