diff options
author | Emmanuele Bassi <ebassi@gnome.org> | 2018-08-22 12:47:30 +0100 |
---|---|---|
committer | Emmanuele Bassi <ebassi@gnome.org> | 2018-08-22 12:48:56 +0100 |
commit | 559c32f243e1102500f918e8c9611877ac42f0f6 (patch) | |
tree | be0b218b2355c82ad542b6c31a3725c0450a53fa | |
parent | 7c783502ede10fd3fa329bc75118a3ffc015973b (diff) | |
download | gdk-pixbuf-559c32f243e1102500f918e8c9611877ac42f0f6.tar.gz |
Documentation fixes for read_pixels() and read_pixels_bytes()
The read_pixels() method is missing a `Returns` stanza.
The read_pixels_bytes() method is missing a description.
Both functions do the same thing, so they should be documented
similarly.
-rw-r--r-- | gdk-pixbuf/gdk-pixbuf.c | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/gdk-pixbuf/gdk-pixbuf.c b/gdk-pixbuf/gdk-pixbuf.c index 1c7fbee64..8e39ac416 100644 --- a/gdk-pixbuf/gdk-pixbuf.c +++ b/gdk-pixbuf/gdk-pixbuf.c @@ -777,11 +777,13 @@ gdk_pixbuf_get_pixels_with_length (const GdkPixbuf *pixbuf, * gdk_pixbuf_read_pixels: * @pixbuf: A pixbuf * - * Returns a read-only pointer to the raw pixel data; must not be + * Provides a read-only pointer to the raw pixel data; must not be * modified. This function allows skipping the implicit copy that * must be made if gdk_pixbuf_get_pixels() is called on a read-only * pixbuf. * + * Returns: a read-only pointer to the raw pixel data + * * Since: 2.32 */ const guint8* @@ -809,10 +811,15 @@ gdk_pixbuf_read_pixels (const GdkPixbuf *pixbuf) * gdk_pixbuf_read_pixel_bytes: * @pixbuf: A pixbuf * + * Provides a #GBytes buffer containing the raw pixel data; the data + * must not be modified. This function allows skipping the implicit + * copy that must be made if gdk_pixbuf_get_pixels() is called on a + * read-only pixbuf. + * * Returns: (transfer full): A new reference to a read-only copy of - * the pixel data. Note that for mutable pixbufs, this function will - * incur a one-time copy of the pixel data for conversion into the - * returned #GBytes. + * the pixel data. Note that for mutable pixbufs, this function will + * incur a one-time copy of the pixel data for conversion into the + * returned #GBytes. * * Since: 2.32 */ |