[gdk-pixbuf/ebassi/for-master: 1/2] docs: Fix the XPM data annotation
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gdk-pixbuf/ebassi/for-master: 1/2] docs: Fix the XPM data annotation
- Date: Tue, 9 Nov 2021 15:11:03 +0000 (UTC)
commit d61130ff1cda1cc1ae307e76abc20a2bae92afca
Author: Emmanuele Bassi <ebassi gnome org>
Date: Tue Nov 9 15:08:33 2021 +0000
docs: Fix the XPM data annotation
Make sure that the array is annotated as zero-terminated.
gdk-pixbuf/gdk-pixbuf-io.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
---
diff --git a/gdk-pixbuf/gdk-pixbuf-io.h b/gdk-pixbuf/gdk-pixbuf-io.h
index 6692ad6a9..cac75f242 100644
--- a/gdk-pixbuf/gdk-pixbuf-io.h
+++ b/gdk-pixbuf/gdk-pixbuf-io.h
@@ -223,18 +223,18 @@ struct _GdkPixbufModulePattern {
*
* In case of error, this function should return `NULL` and set the `error` argument.
*
- * Returns: (transfer full): a `GdkPixbuf` with the contents of the file
+ * Returns: (transfer full): a newly created `GdkPixbuf` for the contents of the file
*/
typedef GdkPixbuf *(* GdkPixbufModuleLoadFunc) (FILE *f,
GError **error);
/**
* GdkPixbufModuleLoadXpmDataFunc:
- * @data: the XPM data, as an array
+ * @data: (array zero-terminated=1): the XPM data
*
* Loads XPM data into a new `GdkPixbuf`.
*
- * Returns: (transfer full): a `GdkPixbuf` with the XPM data
+ * Returns: (transfer full): a newly created `GdkPixbuf` for the XPM data
*/
typedef GdkPixbuf *(* GdkPixbufModuleLoadXpmDataFunc) (const char **data);
@@ -247,7 +247,7 @@ typedef GdkPixbuf *(* GdkPixbufModuleLoadXpmDataFunc) (const char **data);
*
* In case of error, this function should return `NULL` and set the `error` argument.
*
- * Returns: (transfer full): a `GdkPixbufAnimation` with the contents of the file
+ * Returns: (transfer full): a newly created `GdkPixbufAnimation` for the contents of the file
*/
typedef GdkPixbufAnimation *(* GdkPixbufModuleLoadAnimationFunc) (FILE *f,
GError **error);
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]