[gegl] docs: Make GeglBufferIterator show in API reference

[Jon Nordby <jonnor src gnome org>]

commit 01663d93a84afc5cbc8eefe407b73abd9bba2906
Author: Jon Nordby <jononor gmail com>
Date:   Sun May 6 20:42:01 2012 +0200

    docs: Make GeglBufferIterator show in API reference
    
    Also clarify the docs for gegl_buffer_iterator_stop() a bit.

 docs/Makefile.am                   |    2 ++
 gegl/buffer/gegl-buffer-iterator.h |   11 +++++++++--
 2 files changed, 11 insertions(+), 2 deletions(-)
---
diff --git a/docs/Makefile.am b/docs/Makefile.am
index d66c4b6..78d308b 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -149,6 +149,7 @@ endif
 api.html: $(top_srcdir)/gegl/gegl.h\
           $(top_builddir)/gegl/gegl-version.h\
           $(top_srcdir)/gegl/buffer/gegl-buffer.h\
+	  $(top_srcdir)/gegl/buffer/gegl-buffer-iterator.h\
           $(top_srcdir)/gegl/gegl-utils.h\
           $(top_srcdir)/gegl/property-types/gegl-color.h\
           $(top_srcdir)/gegl/gegl-matrix.h\
@@ -160,6 +161,7 @@ if HAVE_RUBY
 	    $(top_srcdir)/gegl/gegl.h			\
 	    $(top_builddir)/gegl/gegl-version.h		\
 	    $(top_srcdir)/gegl/buffer/gegl-buffer.h	\
+	    $(top_srcdir)/gegl/buffer/gegl-buffer-iterator.h\
             $(top_srcdir)/gegl/gegl-utils.h \
             $(top_srcdir)/gegl/property-types/gegl-color.h\
             $(top_srcdir)/gegl/gegl-matrix.h \
diff --git a/gegl/buffer/gegl-buffer-iterator.h b/gegl/buffer/gegl-buffer-iterator.h
index 54ebef1..8773afe 100644
--- a/gegl/buffer/gegl-buffer-iterator.h
+++ b/gegl/buffer/gegl-buffer-iterator.h
@@ -28,6 +28,13 @@
 #define GEGL_BUFFER_WRITE     2
 #define GEGL_BUFFER_READWRITE (GEGL_BUFFER_READ|GEGL_BUFFER_WRITE)
 
+/***
+ * GeglBufferIterator:
+ *
+ * GeglBufferIterator allows to iterate over one or more GeglBuffers.
+ * In each iteration the new data is available as a linear chunk of
+ * memory. See gegl_buffer_iterator_new() and gegl_buffer_iterator_next()
+ */
 typedef struct GeglBufferIterator
 {
   gint          length;
@@ -90,8 +97,8 @@ gint                 gegl_buffer_iterator_add  (GeglBufferIterator  *iterator,
  * gegl_buffer_iterator_stop:
  * @iterator: a GeglBufferIterator
  *
- * Cancels the current iteration, freeing up any temporary resources. You have
- * to bail out of any loop you are currently.
+ * Cancels the current iteration, freeing up any temporary resources. The
+ * iterator handle is no longer valid after invoking this function.
  */
 void                 gegl_buffer_iterator_stop  (GeglBufferIterator *iterator);