From fbf0f42532961be7fd1fdfee27626c5089c23c7d Mon Sep 17 00:00:00 2001
From: Yann Duplouy <yann.duplouy@inria.fr>
Date: Thu, 28 Nov 2019 14:49:00 +0100
Subject: [PATCH] Documenting xbt/random a little bit

---
 include/xbt/random.hpp | 40 ++++++++++++++++++++++++++++++++++++----
 1 file changed, 36 insertions(+), 4 deletions(-)

diff --git a/include/xbt/random.hpp b/include/xbt/random.hpp
index b1d8b1461a..3386f1dd2e 100644
--- a/include/xbt/random.hpp
+++ b/include/xbt/random.hpp
@@ -10,14 +10,46 @@ namespace simgrid {
 namespace xbt {
 namespace random {
 
+/**
+ * @brief Tells xbt/random to use the ad-hoc distribution implementation.
+ */
 void set_implem_xbt();
+/**
+ * @brief Tells xbt/random to use the standard library distribution implementation.
+ */
 void set_implem_std();
+/**
+ * @brief Sets the seed of the Mersenne-Twister RNG
+ */
 void set_mersenne_seed(int);
 
-int uniform_int(int, int);
-double uniform_real(double, double);
-double exponential(double);
-double normal(double, double);
+/**
+ * @brief Draws an integer number uniformly between min and max included
+ *
+ * @param min Minimum value
+ * @param max Maximum value
+ */
+int uniform_int(int min, int max);
+/**
+ * @brief Draws a real number uniformly between min and max included
+ *
+ * @param min Minimum value
+ * @param max Maximum value
+ */
+double uniform_real(double min, double max);
+/**
+ * @brief Draws a real number according to the given exponential distribution
+ *
+ * @param lambda Parameter of the exponential law
+ */
+double exponential(double lambda);
+/**
+ * @brief Draws a real number according to the given normal distribution
+ *
+ * @param mean Mean of the normal distribution
+ * @param sd Standard deviation of the normal distribution
+ */
+double normal(double mean, double sd);
 } // namespace random
 } // namespace xbt
 } // namespace simgrid
-- 
2.20.1