aboutsummaryrefslogtreecommitdiff
path: root/src/file.h
diff options
context:
space:
mode:
authorTheJackiMonster <thejackimonster@gmail.com>2022-04-19 00:31:14 +0200
committerTheJackiMonster <thejackimonster@gmail.com>2022-04-19 00:31:14 +0200
commitfc56c6148f22d363a27c7a39d8d97a2d4d908a92 (patch)
treea6f7a81785104dbfab204fa3566d243c52415604 /src/file.h
parent9ad1e9f834085b034262f9724400bcb52b55b70c (diff)
downloadmessenger-gtk-fc56c6148f22d363a27c7a39d8d97a2d4d908a92.tar.gz
messenger-gtk-fc56c6148f22d363a27c7a39d8d97a2d4d908a92.zip
Added doxygen comments to some headers
Signed-off-by: TheJackiMonster <thejackimonster@gmail.com>
Diffstat (limited to 'src/file.h')
-rw-r--r--src/file.h38
1 files changed, 38 insertions, 0 deletions
diff --git a/src/file.h b/src/file.h
index d9bb090..939ac34 100644
--- a/src/file.h
+++ b/src/file.h
@@ -33,21 +33,59 @@ typedef struct MESSENGER_FileInfo
33 GList *file_messages; 33 GList *file_messages;
34} MESSENGER_FileInfo; 34} MESSENGER_FileInfo;
35 35
36/**
37 * Creates a file information struct to potentially update
38 * all GUI appearances of a specific file at once.
39 *
40 * @param file Chat file
41 */
36void 42void
37file_create_info(struct GNUNET_CHAT_File *file); 43file_create_info(struct GNUNET_CHAT_File *file);
38 44
45/**
46 * Destroys and frees resources allocated for a given
47 * file information struct.
48 *
49 * @param file Chat file
50 */
39void 51void
40file_destroy_info(struct GNUNET_CHAT_File *file); 52file_destroy_info(struct GNUNET_CHAT_File *file);
41 53
54/**
55 * Adds a UI message handle to the list of handles
56 * which get updated by state changes.
57 *
58 * @param file Chat file
59 * @param message UI message handle
60 */
42void 61void
43file_add_ui_message_to_info(const struct GNUNET_CHAT_File *file, 62file_add_ui_message_to_info(const struct GNUNET_CHAT_File *file,
44 UI_MESSAGE_Handle *message); 63 UI_MESSAGE_Handle *message);
45 64
65/**
66 * Updates the connected UI elements for a given
67 * file depending on the current state of its upload
68 * process.
69 *
70 * @param file Chat file
71 * @param completed Amount of uploaded bytes
72 * @param size Size of the file in bytes
73 */
46void 74void
47file_update_upload_info(const struct GNUNET_CHAT_File *file, 75file_update_upload_info(const struct GNUNET_CHAT_File *file,
48 uint64_t completed, 76 uint64_t completed,
49 uint64_t size); 77 uint64_t size);
50 78
79/**
80 * Updates the connected UI elements for a given
81 * file depending on the current state of its download
82 * process.
83 *
84 * @param file Chat file
85 * @param app Messenger application
86 * @param completed Amount of downloaded bytes
87 * @param size Size of the file in bytes
88 */
51void 89void
52file_update_download_info(const struct GNUNET_CHAT_File *file, 90file_update_download_info(const struct GNUNET_CHAT_File *file,
53 MESSENGER_Application *app, 91 MESSENGER_Application *app,