[gimp/soc-2011-warp: 44/72] gimpimagemap: add doc + TODO

[Michael Murà <mmure src gnome org>]

commit 8af350003e88f20351e04d11c262dde10c9911ef
Author: Michael Murà <batolettre gmail com>
Date:   Sat Jul 2 23:15:29 2011 +0200

    gimpimagemap: add doc + TODO

 app/core/gimpimagemap.c |   17 +++++++++++++++++
 1 files changed, 17 insertions(+), 0 deletions(-)
---
diff --git a/app/core/gimpimagemap.c b/app/core/gimpimagemap.c
index da8a416..943671e 100644
--- a/app/core/gimpimagemap.c
+++ b/app/core/gimpimagemap.c
@@ -350,6 +350,17 @@ gimp_image_map_new (GimpDrawable          *drawable,
   return image_map;
 }
 
+/**
+ * gimp_image_map_apply:
+ * @image_map: a #GimpImageMap
+ * @visible: the visible area
+ *
+ * Compute and display the operation over the selection area.
+ * Succesive call to gimp_image_map_apply can be done to update the preview.
+ *
+ * TODO: currently, the @visible area is not used. It should be used to compute
+ * this area in priority.
+ */
 void
 gimp_image_map_apply (GimpImageMap        *image_map,
                       const GeglRectangle *visible)
@@ -433,6 +444,12 @@ gimp_image_map_apply (GimpImageMap        *image_map,
   image_map->idle_id = g_idle_add ((GSourceFunc) gimp_image_map_do, image_map);
 }
 
+/**
+ * gimp_image_map_commit:
+ * @image_map: a #GimpImageMap
+ *
+ * Commit the operation to the drawable.
+ */
 void
 gimp_image_map_commit (GimpImageMap *image_map)
 {