summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBart Massey <bart@cs.pdx.edu>2012-10-28 12:04:19 -0700
committerBart Massey <bart@cs.pdx.edu>2012-10-28 12:04:19 -0700
commit98fea59c11e5dbea4c4e1b6458f03754e311180b (patch)
tree54cefa366e8fc471e29d1aa3bf978bbfb1d30427
parent155d4c90d7ddb599fcff34dfc403b223c3a35ce8 (diff)
downloadutil-image-98fea59c11e5dbea4c4e1b6458f03754e311180b.tar.gz
corrected return value documentation for xcb_image_shm_put()
-rw-r--r--image/xcb_image.h4
1 files changed, 1 insertions, 3 deletions
diff --git a/image/xcb_image.h b/image/xcb_image.h
index f41187d..4ca04ac 100644
--- a/image/xcb_image.h
+++ b/image/xcb_image.h
@@ -501,7 +501,7 @@ xcb_image_subimage(xcb_image_t * image,
* @param src_height The height of the subimage, in pixels.
* @param send_event Indicates whether or not a completion event
* should occur when the image write is complete.
- * @return 1 is no problems occurs.
+ * @return a pointer to the source image if no problem occurs, otherwise 0.
*
* This function combines an image in memory with a shape of the
* specified drawable. The section of the image defined by the @p x, @p y,
@@ -513,8 +513,6 @@ xcb_image_subimage(xcb_image_t * image,
* bits. For XYPixmap and ZPixmap, the depth must match the depth of
* the drawable, or a ``BadMatch'' error results.
*
- * If a problem occurs, the function returns @c 0. Otherwise, it
- * returns @c 1.
* @ingroup xcb__image_t
*/
xcb_image_t *