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/settings.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/settings.h')
-rw-r--r-- | src/ui/settings.h | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/src/ui/settings.h b/src/ui/settings.h index b2b7486..87e7263 100644 --- a/src/ui/settings.h +++ b/src/ui/settings.h | |||
@@ -1,6 +1,6 @@ | |||
1 | /* | 1 | /* |
2 | This file is part of GNUnet. | 2 | This file is part of GNUnet. |
3 | Copyright (C) 2021 GNUnet e.V. | 3 | Copyright (C) 2021--2022 GNUnet e.V. |
4 | 4 | ||
5 | GNUnet is free software: you can redistribute it and/or modify it | 5 | GNUnet is free software: you can redistribute it and/or modify it |
6 | under the terms of the GNU Affero General Public License as published | 6 | under the terms of the GNU Affero General Public License as published |
@@ -52,10 +52,23 @@ typedef struct UI_SETTINGS_Handle | |||
52 | GtkButton *leave_chats_button; | 52 | GtkButton *leave_chats_button; |
53 | } UI_SETTINGS_Handle; | 53 | } UI_SETTINGS_Handle; |
54 | 54 | ||
55 | /** | ||
56 | * Initializes a handle for the settings dialog | ||
57 | * of a given messenger application. | ||
58 | * | ||
59 | * @param app Messenger application | ||
60 | * @param handle Settings dialog handle | ||
61 | */ | ||
55 | void | 62 | void |
56 | ui_settings_dialog_init(MESSENGER_Application *app, | 63 | ui_settings_dialog_init(MESSENGER_Application *app, |
57 | UI_SETTINGS_Handle *handle); | 64 | UI_SETTINGS_Handle *handle); |
58 | 65 | ||
66 | /** | ||
67 | * Cleans up the allocated resources and resets the | ||
68 | * state of a given settings dialog handle. | ||
69 | * | ||
70 | * @param handle Settings dialog handle | ||
71 | */ | ||
59 | void | 72 | void |
60 | ui_settings_dialog_cleanup(UI_SETTINGS_Handle *handle); | 73 | ui_settings_dialog_cleanup(UI_SETTINGS_Handle *handle); |
61 | 74 | ||