Commit 559c32f2 authored by Emmanuele Bassi's avatar Emmanuele Bassi 👣
Browse files

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.
parent 7c783502
......@@ -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
*/
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment