[gegl] gegl-random: add documentation strings



commit 4bf52f7b7703841a4798d0a355342ba1b60880fe
Author: Ãyvind KolÃs <pippin gimp org>
Date:   Sat Dec 29 13:18:26 2012 +1100

    gegl-random: add documentation strings

 gegl/gegl.h |   56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 files changed, 55 insertions(+), 1 deletions(-)
---
diff --git a/gegl/gegl.h b/gegl/gegl.h
index 3964ba9..fd97016 100644
--- a/gegl/gegl.h
+++ b/gegl/gegl.h
@@ -900,10 +900,64 @@ GeglNode *gegl_node (const gchar *op_type,
  */
 GeglNode *gegl_graph (GeglNode *node);
 
-
+/**
+ * gegl_random_double_range:
+ * @seed: an integer seed, change for different permutation
+ * @x: x coordinate
+ * @y: y coordinate
+ * @z: z coordinate (mipmap level)
+ * @n: number no (each x,y coordinate provides its own sequence of
+ * numbers
+ * @min: minimum value
+ * @max: maxmimum value
+ *
+ * Return a random floating point number in the range specified,
+ * for the given x,y coordinates and seed provided, if multiple different
+ * numbers are needed pass in incrementing n's.
+ */
 double gegl_random_double_range (int seed, int x, int y, int z, int n, double min, double max);
+
+/**
+ * gegl_random_int_range:
+ * @seed: an integer seed, change for different permutation
+ * @x: x coordinate
+ * @y: y coordinate
+ * @z: z coordinate (mipmap level)
+ * @n: number no (each x,y coordinate provides its own sequence of
+ * numbers
+ * @min: minimum value
+ * @max: maxmimum value+1
+ *
+ * Return a random integer point number in the range specified,
+ * for the given x,y coordinates and seed provided, if multiple different
+ * numbers are needed pass in incrementing n's.
+ */
 gint64 gegl_random_int_range    (int seed, int x, int y, int z, int n, int min, int max);
+
+/**
+ * gegl_random_int:
+ * @seed: an integer seed, change for different permutation
+ * @x: x coordinate
+ * @y: y coordinate
+ * @z: z coordinate (mipmap level)
+ * @n: number no (each x,y coordinate provides its own sequence of
+ * numbers
+ *
+ * Return a random integer number in range MIN_INT .. MAX_INT
+ */
 gint64 gegl_random_int          (int seed, int x, int y, int z, int n);
+
+/**
+ * gegl_random_double:
+ * @seed: an integer seed, change for different permutation
+ * @x: x coordinate
+ * @y: y coordinate
+ * @z: z coordinate (mipmap level)
+ * @n: number no (each x,y coordinate provides its own sequence of
+ * numbers
+ *
+ * Return a random floating point number in range 0.0 .. 1.0.
+ */
 double gegl_random_double       (int seed, int x, int y, int z, int n);
 
 #define GEGL_ALIGNED __restrict__ __attribute__((__aligned__ (16)))



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