Fix docs not to talk about %NULL returns. #4271, Duncan Coutts.

This commit is contained in:
Owen Taylor 2005-08-27 18:40:46 +00:00
parent c0da73e1b8
commit 3c53414cf3
2 changed files with 20 additions and 4 deletions

View file

@ -1,3 +1,9 @@
2005-08-27 Owen Taylor <otaylor@redhat.com>
* src/cairo-image-surface.c (cairo_image_surface_create)
(cairo_image_surface_create_for_data): Fix docs not to talk about
%NULL returns. #4271, Duncan Coutts.
2005-08-25 Tor Lillqvist <tml@novell.com>
* Makefile.am (developer_zip_file): Include the documentation, too.

View file

@ -149,8 +149,13 @@ _create_pixman_format (cairo_format_t format)
* must explicitely clear the buffer, using, for example,
* cairo_rectangle() and cairo_fill() if you want it cleared.
*
* Return value: the newly created surface, or %NULL if it couldn't
* be created because of lack of memory
* Return value: a pointer to the newly created surface. The caller
* owns the surface and should call cairo_surface_destroy when done
* with it.
*
* This function always returns a valid pointer, but it will return a
* pointer to a "nil" surface if an error such as out of memory
* occurs. You can use cairo_surface_status() to check for this.
**/
cairo_surface_t *
cairo_image_surface_create (cairo_format_t format,
@ -203,8 +208,13 @@ cairo_image_surface_create (cairo_format_t format,
* must explicitely clear the buffer, using, for example,
* cairo_rectangle() and cairo_fill() if you want it cleared.
*
* Return value: the newly created surface, or %NULL if it couldn't
* be created because of lack of memory
* Return value: a pointer to the newly created surface. The caller
* owns the surface and should call cairo_surface_destroy when done
* with it.
*
* This function always returns a valid pointer, but it will return a
* pointer to a "nil" surface if an error such as out of memory
* occurs. You can use cairo_surface_status() to check for this.
**/
cairo_surface_t *
cairo_image_surface_create_for_data (unsigned char *data,