[gegl] doc: generate the documentation of gegl-random

[Téo Mazars <teom src gnome org>]

commit 11e1989d920dcb76c6dc8dba2057499a0ba1899b
Author: Téo Mazars <teomazars gmail com>
Date:   Sun Nov 24 12:33:14 2013 +0100

    doc: generate the documentation of gegl-random
    
    and properly align files in Makefile.am

 docs/Makefile.am   |   13 +++++++------
 gegl/gegl-random.h |   43 +++++++++++++++++++++++++++++++++++++------
 2 files changed, 44 insertions(+), 12 deletions(-)
---
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 0fe22bb..eec4899 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -180,13 +180,14 @@ endif
 API_DOC_FILES = \
        $(top_srcdir)/gegl/gegl.h                       \
        $(top_builddir)/gegl/gegl-version.h             \
-       $(top_srcdir)/gegl/buffer/gegl-buffer.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 \
-    $(top_srcdir)/gegl/property-types/gegl-path.h\
-    $(top_srcdir)/gegl/property-types/gegl-curve.h
+       $(top_srcdir)/gegl/gegl-utils.h                 \
+       $(top_srcdir)/gegl/gegl-random.h                \
+       $(top_srcdir)/gegl/property-types/gegl-color.h  \
+       $(top_srcdir)/gegl/gegl-matrix.h                \
+       $(top_srcdir)/gegl/property-types/gegl-path.h   \
+       $(top_srcdir)/gegl/property-types/gegl-curve.h
 
 api.html: $(API_DOC_FILES) \
          $(top_srcdir)/tools/create-reference.rb
diff --git a/gegl/gegl-random.h b/gegl/gegl-random.h
index d7f3dfc..4b9b307 100644
--- a/gegl/gegl-random.h
+++ b/gegl/gegl-random.h
@@ -24,6 +24,15 @@
 
 G_BEGIN_DECLS
 
+/***
+ * Random numbers:
+ *
+ * GEGL provides functions to generate deterministic random numbers,
+ * based on a seed and on 2D coordinates. It allows to reproduce the
+ * same sequence of random numbers in both CPU and GPU devices where
+ * operations are not done in the same order.
+ */
+
 /**
  * gegl_random_new_with_seed:
  * @seed: an integer seed, change for different permutation.
@@ -53,7 +62,8 @@ GeglRandom* gegl_random_duplicate (GeglRandom *rand);
  * gegl_random_free:
  * @rand: The GeglRandom structure to free
  *
- * Free a GeglRandom structure created with gegl_random_new() or gegl_random_new_with_seed()
+ * Free a GeglRandom structure created with gegl_random_new() or
+ * gegl_random_new_with_seed()
  */
 void gegl_random_free (GeglRandom *rand);
 
@@ -64,7 +74,8 @@ void gegl_random_free (GeglRandom *rand);
  *
  * Change the seed of an existing GeglRandom.
  */
-void gegl_random_set_seed (GeglRandom *rand, guint32 seed);
+void gegl_random_set_seed (GeglRandom *rand,
+                           guint32     seed);
 
 /**
  * gegl_random_float_range:
@@ -81,7 +92,13 @@ void gegl_random_set_seed (GeglRandom *rand, guint32 seed);
  * for the given x,y coordinates and GeglRandom provided, if multiple different
  * numbers are needed pass in incrementing n's.
  */
-gfloat gegl_random_float_range (const GeglRandom *rand, gint x, gint y, gint z, gint n, gfloat min, gfloat 
max);
+gfloat gegl_random_float_range (const GeglRandom *rand,
+                                gint              x,
+                                gint              y,
+                                gint              z,
+                                gint              n,
+                                gfloat            min,
+                                gfloat            max);
 
 /**
  * gegl_random_int_range:
@@ -98,7 +115,13 @@ gfloat gegl_random_float_range (const GeglRandom *rand, gint x, gint y, gint z,
  * for the given x,y coordinates and GeglRandom provided, if multiple different
  * numbers are needed pass in incrementing n's.
  */
-gint32 gegl_random_int_range (const GeglRandom *rand, gint x, gint y, gint z, gint n, gint min, gint max);
+gint32 gegl_random_int_range (const GeglRandom *rand,
+                              gint              x,
+                              gint              y,
+                              gint              z,
+                              gint              n,
+                              gint              min,
+                              gint              max);
 
 /**
  * gegl_random_int:
@@ -111,7 +134,11 @@ gint32 gegl_random_int_range (const GeglRandom *rand, gint x, gint y, gint z, gi
  *
  * Return a random integer number in range 0 .. MAX_UINT
  */
-guint32 gegl_random_int (const GeglRandom *rand, gint x, gint y, gint z, gint n);
+guint32 gegl_random_int (const GeglRandom *rand,
+                         gint              x,
+                         gint              y,
+                         gint              z,
+                         gint              n);
 
 /**
  * gegl_random_float:
@@ -124,7 +151,11 @@ guint32 gegl_random_int (const GeglRandom *rand, gint x, gint y, gint z, gint n)
  *
  * Return a random floating point number in range 0.0 .. 1.0.
  */
-gfloat gegl_random_float (const GeglRandom *rand, gint x, gint y, gint z, gint n);
+gfloat gegl_random_float (const GeglRandom *rand,
+                          gint              x,
+                          gint              y,
+                          gint              z,
+                          gint              n);
 
 G_END_DECLS