X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5a99bd94a2cedf8b455e78de53b19bebab8c034e..814f0122ea0074dfb67398a79067c01267bc0b40:/src/mc/mc_base.h

diff --git a/src/mc/mc_base.h b/src/mc/mc_base.h
index c46241459f..d972c52b40 100644
--- a/src/mc/mc_base.h
+++ b/src/mc/mc_base.h
@@ -7,6 +7,7 @@
 #ifndef MC_BASE_H
 #define MC_BASE_H
 
+#include <xbt/misc.h>
 #include <simgrid/simix.h>
 #include "simgrid_config.h"
 #include "internal_config.h"
@@ -14,8 +15,24 @@
 
 SG_BEGIN_DECL()
 
+/** Check if the given simcall can be resolved
+ *
+ *  \return `TRUE` or `FALSE`
+ */
 int MC_request_is_enabled(smx_simcall_t req);
+
+/** Check if the given simcall is visible
+ *
+ *  \return `TRUE` or `FALSE`
+ */
 int MC_request_is_visible(smx_simcall_t req);
+
+/** Execute everything which is invisible
+ *
+ *  Execute all the processes that are ready to run and all invisible simcalls
+ *  iteratively until there doesn't remain any. At this point, the function
+ *  returns to the caller which can handle the visible (and ready) simcalls.
+ */
 void MC_wait_for_requests(void);
 
 extern double *mc_time;