[glib: 1/2] gbytesicon: Fix error in g_bytes_icon_new() documentation




commit d26d70d66acef5cd2ba29e0998962cfb7e56ef1a
Author: Philip Withnall <pwithnall endlessos org>
Date:   Sun Mar 14 15:53:24 2021 +0000

    gbytesicon: Fix error in g_bytes_icon_new() documentation
    
    It said that `NULL` could be returned, but actually `g_bytes_icon_new()`
    can never fail.
    
    Signed-off-by: Philip Withnall <pwithnall endlessos org>

 gio/gbytesicon.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
---
diff --git a/gio/gbytesicon.c b/gio/gbytesicon.c
index b2323d905..4103b60bc 100644
--- a/gio/gbytesicon.c
+++ b/gio/gbytesicon.c
@@ -146,8 +146,11 @@ g_bytes_icon_init (GBytesIcon *bytes)
  *
  * Creates a new icon for a bytes.
  *
+ * This cannot fail, but loading and interpreting the bytes may fail later on
+ * (for example, if g_loadable_icon_load() is called) if the image is invalid.
+ *
  * Returns: (transfer full) (type GBytesIcon): a #GIcon for the given
- *   @bytes, or %NULL on error.
+ *   @bytes.
  *
  * Since: 2.38
  **/


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