diff options
author | Chris Wilson <chris@chris-wilson.co.uk> | 2009-02-12 10:42:24 +0000 |
---|---|---|
committer | Chris Wilson <chris@chris-wilson.co.uk> | 2009-02-12 10:42:24 +0000 |
commit | e7d4bc3d864b1b42bb1cae031036ddf6a4445d3c (patch) | |
tree | 19f8f40e6a2cb3bd8fc7b74d1dcbb218bb510624 /src/cairo-png.c | |
parent | a5c1cdf2b030959309e1645bd115f058f1367296 (diff) | |
download | cairo-e7d4bc3d864b1b42bb1cae031036ddf6a4445d3c.tar.gz |
[png] Correct documentation to avoid reference to NULL
As pointed out by Truc Truong,
cairo_image_surface_create_from_png_stream() cannot return NULL and so the
documentation was incorrect.
Fixes http://bugs.freedesktop.org/show_bug.cgi?id=20075
Bug 20075 There is a misprint in the spec for
cairo_image_surface_create_from_png_stream() function
Diffstat (limited to 'src/cairo-png.c')
-rw-r--r-- | src/cairo-png.c | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/src/cairo-png.c b/src/cairo-png.c index 06e7cb557..93317f36f 100644 --- a/src/cairo-png.c +++ b/src/cairo-png.c @@ -631,6 +631,10 @@ stdio_read_func (png_structp png, png_bytep data, png_size_t size) * %CAIRO_STATUS_NO_MEMORY * %CAIRO_STATUS_FILE_NOT_FOUND * %CAIRO_STATUS_READ_ERROR + * + * Alternatively, you can allow errors to propagate through the drawing + * operations and check the status on the context upon completion + * using cairo_status(). **/ cairo_surface_t * cairo_image_surface_create_from_png (const char *filename) @@ -692,8 +696,17 @@ stream_read_func (png_structp png, png_bytep data, png_size_t size) * via the @read_func function. * * Return value: a new #cairo_surface_t initialized with the contents - * of the PNG file or %NULL if the data read is not a valid PNG image or - * memory could not be allocated for the operation. + * of the PNG file or a "nil" surface if the data read is not a valid PNG image + * or memory could not be allocated for the operation. A nil + * surface can be checked for with cairo_surface_status(surface) which + * may return one of the following values: + * + * %CAIRO_STATUS_NO_MEMORY + * %CAIRO_STATUS_READ_ERROR + * + * Alternatively, you can allow errors to propagate through the drawing + * operations and check the status on the context upon completion + * using cairo_status(). **/ cairo_surface_t * cairo_image_surface_create_from_png_stream (cairo_read_func_t read_func, |