[glib/gio/gfileinfo/g_file_info_get_size/documentation] Improving documentation for g_file_info_get_size, fixing #2333




commit 73182528fa372455fdd0242b461ffed058eccf33
Author: Uwe Scholz <u scholz83 gmx de>
Date:   Wed Feb 24 23:13:27 2021 +0100

    Improving documentation for g_file_info_get_size, fixing #2333

 gio/gfileinfo.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
---
diff --git a/gio/gfileinfo.c b/gio/gfileinfo.c
index 42cdc7a5d..b83afa130 100644
--- a/gio/gfileinfo.c
+++ b/gio/gfileinfo.c
@@ -1733,9 +1733,10 @@ g_file_info_get_content_type (GFileInfo *info)
  * g_file_info_get_size:
  * @info: a #GFileInfo.
  *
- * Gets the file's size.
+ * Gets the file's size (in bytes). The size is internally converted
+ * from #guint64 to #goffset before returning the result.
  *
- * Returns: a #goffset containing the file's size.
+ * Returns: a #goffset containing the file's size (in bytes).
  **/
 goffset
 g_file_info_get_size (GFileInfo *info)


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]