Merge branch 'wifi_rate_zero' into 'master'

[simgrid.git] / include / simgrid / modelchecker.h

diff --git a/include/simgrid/modelchecker.h b/include/simgrid/modelchecker.h
index f071a26..661fc12 100644 (file)
--- a/include/simgrid/modelchecker.h
+++ b/include/simgrid/modelchecker.h
@@ -1,6 +1,6 @@
 /* simgrid/modelchecker.h - Formal Verification made possible in SimGrid    */
 
-/* Copyright (c) 2008-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2008-2022. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -19,8 +19,9 @@
 
 #include <stddef.h> /* size_t */
 
-SG_BEGIN_DECL()
+SG_BEGIN_DECL
 
+/** Explore every branches where that function returns a value between min and max (inclusive) */
 XBT_PUBLIC int MC_random(int min, int max);
 
 #if SIMGRID_HAVE_MC
@@ -31,7 +32,7 @@ XBT_PUBLIC int MC_random(int min, int max);
 extern XBT_PUBLIC int _sg_do_model_check;
 extern XBT_PUBLIC int _sg_mc_max_visited_states;
 
-#define MC_is_active()                  _sg_do_model_check
+#define MC_is_active()         _sg_do_model_check
 #define MC_visited_reduction() _sg_mc_max_visited_states
 
 /** Assertion for the model-checker
@@ -67,6 +68,6 @@ XBT_PUBLIC void MC_ignore_global_variable(const char* var_name);
 
 #endif
 
-SG_END_DECL()
+SG_END_DECL
 
 #endif /* SIMGRID_MODELCHECKER_H */