Markup fixes.

* gdk-pixbuf-loader.c, gdk-pixbuf-util.c: Markup fixes.
This commit is contained in:
Matthias Clasen
2001-12-12 22:11:37 +00:00
parent af7ab9c630
commit 5b20006878
3 changed files with 17 additions and 13 deletions

View File

@ -1,3 +1,7 @@
2001-12-12 Matthias Clasen <matthiasc@poet.de>
* gdk-pixbuf-loader.c, gdk-pixbuf-util.c: Markup fixes.
2001-12-11 Michael Natterer <mitch@gimp.org> 2001-12-11 Michael Natterer <mitch@gimp.org>
* io-png.c: gdk_pixbuf__png_image_save: removed wrong endian * io-png.c: gdk_pixbuf__png_image_save: removed wrong endian

View File

@ -318,13 +318,13 @@ gdk_pixbuf_loader_eat_header_write (GdkPixbufLoader *loader,
* @error: return location for errors * @error: return location for errors
* *
* This will cause a pixbuf loader to parse the next @count bytes of * This will cause a pixbuf loader to parse the next @count bytes of
* an image. It will return TRUE if the data was loaded successfully, * an image. It will return %TRUE if the data was loaded successfully,
* and FALSE if an error occurred. In the latter case, the loader * and %FALSE if an error occurred. In the latter case, the loader
* will be closed, and will not accept further writes. If FALSE is * will be closed, and will not accept further writes. If %FALSE is
* returned, @error will be set to an error from the #GDK_PIXBUF_ERROR * returned, @error will be set to an error from the #GDK_PIXBUF_ERROR
* or #G_FILE_ERROR domains. * or #G_FILE_ERROR domains.
* *
* Return value: #TRUE if the write was successful, or #FALSE if the loader * Return value: %TRUE if the write was successful, or %FALSE if the loader
* cannot parse the buffer. * cannot parse the buffer.
**/ **/
gboolean gboolean
@ -435,7 +435,7 @@ gdk_pixbuf_loader_new_with_type (const char *image_type,
* gdk_pixbuf_loader_get_pixbuf: * gdk_pixbuf_loader_get_pixbuf:
* @loader: A pixbuf loader. * @loader: A pixbuf loader.
* *
* Queries the GdkPixbuf that a pixbuf loader is currently creating. * Queries the #GdkPixbuf that a pixbuf loader is currently creating.
* In general it only makes sense to call this function after the * In general it only makes sense to call this function after the
* "area_prepared" signal has been emitted by the loader; this means * "area_prepared" signal has been emitted by the loader; this means
* that enough data has been read to know the size of the image that * that enough data has been read to know the size of the image that
@ -470,13 +470,13 @@ gdk_pixbuf_loader_get_pixbuf (GdkPixbufLoader *loader)
* gdk_pixbuf_loader_get_animation: * gdk_pixbuf_loader_get_animation:
* @loader: A pixbuf loader * @loader: A pixbuf loader
* *
* Queries the GdkPixbufAnimation that a pixbuf loader is currently creating. * Queries the #GdkPixbufAnimation that a pixbuf loader is currently creating.
* In general it only makes sense to call this function afer the "area_prepared" * In general it only makes sense to call this function afer the "area_prepared"
* signal has been emitted by the loader. If the loader doesn't have enough * signal has been emitted by the loader. If the loader doesn't have enough
* bytes yet (hasn't emitted the area_prepared signal) this function will return * bytes yet (hasn't emitted the "area_prepared" signal) this function will
* %NULL. * return %NULL.
* *
* Return value: The GdkPixbufAnimation that the loader is loading, or NULL if * Return value: The #GdkPixbufAnimation that the loader is loading, or %NULL if
not enough data has been read to determine the information. not enough data has been read to determine the information.
**/ **/
GdkPixbufAnimation * GdkPixbufAnimation *
@ -501,7 +501,7 @@ gdk_pixbuf_loader_get_animation (GdkPixbufLoader *loader)
* gdk_pixbuf_loader_write() will occur, so that it can free its * gdk_pixbuf_loader_write() will occur, so that it can free its
* internal loading structures. Also, tries to parse any data that * internal loading structures. Also, tries to parse any data that
* hasn't yet been parsed; if the remaining data is partial or * hasn't yet been parsed; if the remaining data is partial or
* corrupt, an error will be returned. If FALSE is returned, @error * corrupt, an error will be returned. If %FALSE is returned, @error
* will be set to an error from the #GDK_PIXBUF_ERROR or #G_FILE_ERROR * will be set to an error from the #GDK_PIXBUF_ERROR or #G_FILE_ERROR
* domains. If you're just cancelling a load rather than expecting it * domains. If you're just cancelling a load rather than expecting it
* to be finished, passing %NULL for @error to ignore it is * to be finished, passing %NULL for @error to ignore it is

View File

@ -31,7 +31,7 @@
* gdk_pixbuf_add_alpha: * gdk_pixbuf_add_alpha:
* @pixbuf: A pixbuf. * @pixbuf: A pixbuf.
* @substitute_color: Whether to set a color to zero opacity. If this * @substitute_color: Whether to set a color to zero opacity. If this
* is #FALSE, then the (@r, @g, @b) arguments will be ignored. * is %FALSE, then the (@r, @g, @b) arguments will be ignored.
* @r: Red value to substitute. * @r: Red value to substitute.
* @g: Green value to substitute. * @g: Green value to substitute.
* @b: Blue value to substitute. * @b: Blue value to substitute.
@ -41,7 +41,7 @@
* values are copied from the original; otherwise, the alpha channel * values are copied from the original; otherwise, the alpha channel
* is initialized to 255 (full opacity). * is initialized to 255 (full opacity).
* *
* If @substitute_color is #TRUE, then the color specified by (@r, @g, @b) will be * If @substitute_color is %TRUE, then the color specified by (@r, @g, @b) will be
* assigned zero opacity. That is, if you pass (255, 255, 255) for the * assigned zero opacity. That is, if you pass (255, 255, 255) for the
* substitute color, all white pixels will become fully transparent. * substitute color, all white pixels will become fully transparent.
* *
@ -165,7 +165,7 @@ gdk_pixbuf_copy_area (const GdkPixbuf *src_pixbuf,
* effects. If @saturation is 1.0 then saturation is not changed. If * effects. If @saturation is 1.0 then saturation is not changed. If
* it's less than 1.0, saturation is reduced (the image is darkened); * it's less than 1.0, saturation is reduced (the image is darkened);
* if greater than 1.0, saturation is increased (the image is * if greater than 1.0, saturation is increased (the image is
* brightened). If @pixelate is TRUE, then pixels are faded in a * brightened). If @pixelate is %TRUE, then pixels are faded in a
* checkerboard pattern to create a pixelated image. @src and @dest * checkerboard pattern to create a pixelated image. @src and @dest
* must have the same image format, size, and rowstride. * must have the same image format, size, and rowstride.
* *