/****************************************************************************/
/* Manipulating User Data */
/****************************************************************************/
+
+/** \addtogroup GRAS_globals
+ * \brief Handling global variables so that it works on simulator (Virtualization).
+ *
+ * In GRAS, using globals is forbidden since the "processes" will
+ * sometimes run as a thread inside the same process (namely, in
+ * simulation mode). So, you have to put all globals in a structure, and
+ * let GRAS handle it.
+ *
+ * Use the \ref gras_userdata_new macro to create a new user data (or malloc it
+ * and use \ref gras_userdata_set yourself), and \ref gras_userdata_get to
+ * retrive a reference to it.
+ */
+/*@{*/
+
/**
* \brief Get the data associated with the current process.
* \ingroup GRAS_globals
*/
void gras_userdata_set(void *ud);
-/**
- * \brief Malloc and set the data associated with the current process.
- * \ingroup GRAS_globals
- */
-
+/** \brief Malloc and set the data associated with the current process. */
#define gras_userdata_new(type) (gras_userdata_set(xbt_new0(type,1)),gras_userdata_get())
+/*@}*/
END_DECL()