[gimp] app/base: Add gtk-doc to pixel_region_init()



commit 8d0be04e51fcb737c3404c26c77dbab09258ac34
Author: Martin Nordholts <martinn src gnome org>
Date:   Sat Aug 21 12:27:52 2010 +0200

    app/base: Add gtk-doc to pixel_region_init()

 app/base/pixel-region.c |   14 ++++++++++++++
 1 files changed, 14 insertions(+), 0 deletions(-)
---
diff --git a/app/base/pixel-region.c b/app/base/pixel-region.c
index 5aaa33d..e8a5fe9 100644
--- a/app/base/pixel-region.c
+++ b/app/base/pixel-region.c
@@ -43,6 +43,20 @@ static void                  pixel_region_configure  (PixelRegionHolder   *PRH,
 /**************************/
 /*  Function definitions  */
 
+/**
+ * pixel_region_init:
+ * @PR:    Pointer to PixelRegion struct, typically allocated on the
+ *         stack
+ * @tiles: Tiles
+ * @x:     X of region
+ * @y:     Y of region
+ * @w:     Width of region
+ * @h:     Height of region
+ * @dirty: %TRUE if there will be changes to the pixel region that
+ *         shall be written back to the tiles, %FALSE otherwise
+ *
+ * Initializes a pixel region over a set of tiles.
+ **/
 void
 pixel_region_init (PixelRegion *PR,
                    TileManager *tiles,



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]