X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/29a3b2869c0075fc75e8ccc66fc1d9c4c8bf6a85..93c7b4bd9208b45b5a5899abd1da65262431c33f:/include/simgrid/msg.h?ds=sidebyside
diff --git a/include/simgrid/msg.h b/include/simgrid/msg.h
index 9f103aecdc..87b46fcff9 100644
--- a/include/simgrid/msg.h
+++ b/include/simgrid/msg.h
@@ -155,6 +155,14 @@ XBT_PUBLIC sg_size_t MSG_storage_read(msg_storage_t storage, sg_size_t size);
XBT_PUBLIC sg_size_t MSG_storage_write(msg_storage_t storage, sg_size_t size);
/* ******************************** Actor/process *************************** */
+/** Processes are independent agents that can do stuff on their own.
+ * They are in charge of executing your code interacting with the simulated world.
+ * A process may be defined as a code with some private data.
+ * Processes must be located on hosts (#msg_host_t), and they exchange data by sending tasks (#msg_task_t)
+ * that are similar to envelops containing data.
+ *
+ * @hideinitializer
+ */
typedef sg_actor_t msg_process_t;
XBT_PUBLIC int MSG_process_get_PID(msg_process_t process);
@@ -237,9 +245,7 @@ typedef struct msg_task* msg_task_t;
/** @brief Default value for an uninitialized #msg_task_t. */
#define MSG_TASK_UNINITIALIZED NULL
-/** @brief Return code of most MSG functions
- @ingroup msg_simulation
- @{ */
+/** @brief Return code of most MSG functions */
/* Keep these code as binary values: java bindings manipulate | of these values */
typedef enum {
MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */
@@ -252,7 +258,6 @@ typedef enum {
return now !*/
MSG_TASK_CANCELED = 8 /**< @brief Canceled task. This task has been canceled by somebody!*/
} msg_error_t;
-/** @} */
/************************** Global ******************************************/
/** @brief set a configuration variable
@@ -264,8 +269,7 @@ typedef enum {
* MSG_config("host/model","ptask_L07");
*/
XBT_PUBLIC void MSG_config(const char* key, const char* value);
-/** @ingroup msg_simulation
- * @brief Initialize the MSG internal data.
+/** @brief Initialize the MSG internal data.
* @hideinitializer
*
* It also check that the link-time and compile-time versions of SimGrid do
@@ -428,7 +432,6 @@ XBT_PUBLIC const char* MSG_task_get_category(msg_task_t task);
XBT_PUBLIC void MSG_mailbox_set_async(const char* alias);
/** @brief Opaque type representing a semaphore
- * @ingroup msg_synchro
* @hideinitializer
*/
typedef struct s_smx_sem_t* msg_sem_t; // Yeah that's a rename of the smx_sem_t which doesnt require smx_sem_t to be