gimp r26783 - in trunk: . app/base

[neo svn gnome org]

Author: neo
Date: Tue Aug 26 21:06:09 2008
New Revision: 26783
URL: http://svn.gnome.org/viewvc/gimp?rev=26783&view=rev

Log:
2008-08-26  Sven Neumann  <sven gimp org>

	* app/base/pixel-surround.c: updated documentation.



Modified:
   trunk/ChangeLog
   trunk/app/base/pixel-surround.c

Modified: trunk/app/base/pixel-surround.c
==============================================================================
--- trunk/app/base/pixel-surround.c	(original)
+++ trunk/app/base/pixel-surround.c	Tue Aug 26 21:06:09 2008
@@ -62,7 +62,11 @@
  * @tiles:  tile manager
  * @width:  width of surround region
  * @height: height of surround region
- * @bg:     color to use for pixels that are not covered by the tile manager
+ * @mode:   how to deal with pixels that are not covered by the tile manager
+ *
+ * PixelSurround provides you a contiguous read-only view of the area
+ * surrounding a pixel. It is an efficient pixel access strategy for
+ * interpolation algorithms.
  *
  * Return value: a new #PixelSurround.
  */
@@ -94,6 +98,15 @@
   return surround;
 }
 
+/**
+ * pixel_surround_set_bg:
+ * @surround: a #PixelSurround
+ * @bg:       background color
+ *
+ * This sets the color that the #PixelSurround uses when in
+ * %PIXEL_SURROUND_BACKGROUND mode for pixels that are not covered by
+ * the tile manager.
+ */
 void
 pixel_surround_set_bg (PixelSurround *surround,
                        const guchar  *bg)