X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/75206281a5a59ea2acdfd376a38433a79d692370..1906319f3340a70c04f334e2b5b35219b0cc7ae6:/include/msg/datatypes.h

diff --git a/include/msg/datatypes.h b/include/msg/datatypes.h
index db4b38aee1..e8b5ce161f 100644
--- a/include/msg/datatypes.h
+++ b/include/msg/datatypes.h
@@ -7,17 +7,24 @@
 
 #ifndef MSG_DATATYPE_H
 #define MSG_DATATYPE_H
+#include "xbt/misc.h"
 
-/********************************* Host **************************************/
+SG_BEGIN_DECL()
+
+/* ******************************** Host ************************************ */
+/** @defgroup m_datatypes_management_details Details on MSG datatypes
+    @ingroup  m_datatypes_management*/
 
 typedef struct simdata_host *simdata_host_t;
+/** @brief Host datatype 
+    @ingroup m_datatypes_management_details */
 typedef struct m_host {
-  char *name;			/* host name if any */
-  simdata_host_t simdata;	/* simulator data */
-  void *data;			/* user data */
+  char *name;			/**< @brief host name if any */
+  simdata_host_t simdata;	/**< @brief simulator data */
+  void *data;			/**< @brief user data */
 } s_m_host_t;
-/** \brief Host datatype  
-    \ingroup m_datatypes_management
+/** @brief Host datatype  
+    @ingroup m_datatypes_management
 
     A <em>location</em> (or <em>host</em>) is any possible place where
     a process may run. Thus it is represented as a <em>physical
@@ -27,106 +34,87 @@ typedef struct m_host {
     process.
 
     \see m_host_management
-*/
-typedef s_m_host_t *m_host_t;
-
-/********************************* Task **************************************/
+  @{ */
+typedef struct m_host *m_host_t;
+/** @} */
+/* ******************************** Task ************************************ */
 
 typedef struct simdata_task *simdata_task_t;
+/** @brief Task datatype 
+    @ingroup m_datatypes_management_details */
 typedef struct m_task {
-  char *name;			/* host name if any */
-  simdata_task_t simdata;	/* simulator data */
-  void *data;			/* user data */
+  char *name;			/**< @brief task name if any */
+  simdata_task_t simdata;	/**< @brief simulator data */
+  void *data;			/**< @brief user data */
 } s_m_task_t;
-
-/** \brief Task datatype  
-    \ingroup m_datatypes_management 
+/** @brief Task datatype  
+    @ingroup m_datatypes_management 
 
     A <em>task</em> may then be defined by a <em>computing
     amount</em>, a <em>message size</em> and some <em>private
     data</em>.
     \see m_task_management
-*/
-typedef s_m_task_t *m_task_t;
+  @{ */
+typedef struct m_task  *m_task_t;
 
 /** \brief Default value for an uninitialized #m_task_t.
     \ingroup m_datatypes_management 
 */
 #define MSG_TASK_UNINITIALIZED NULL
 
-/******************************* Process *************************************/
+/** @} */
+
+/* ****************************** Process *********************************** */
 typedef struct simdata_process *simdata_process_t;
+/** @brief Process datatype 
+    @ingroup m_datatypes_management_details @{ */
 typedef struct m_process {
-  char *name;			/* process name if any */
-  simdata_process_t simdata;	/* simulator data */
-  void *data;			/* user data */
+  char *name;			/**< @brief process name if any */
+  simdata_process_t simdata;	/**< @brief simulator data */
+  void *data;			/**< @brief user data */
 } s_m_process_t;
-/** \brief Agent datatype  
-    \ingroup m_datatypes_management 
+/** @} */
+/** @brief Agent datatype  
+    @ingroup m_datatypes_management 
+
     An agent may be defined as a <em>code</em>, with some <em>private
     data</em>, executing in a <em>location</em>.
     \see m_process_management
-*/
-typedef s_m_process_t *m_process_t;
-/** \brief Agent code datatype  
-    \ingroup m_datatypes_management 
-    The code of an agent is a m_process_code_t, i.e. a function with no arguments 
-    returning no value.
-    \see m_process_management
-*/
-typedef int(*m_process_code_t)(int argc,char *argv[]) ;
+  @{ */
+typedef struct m_process *m_process_t;
+/** @} */
+
+/* ********************************* Channel ******************************** */
+/** @brief Channel datatype  
+    @ingroup m_datatypes_management 
 
-/********************************** Channel **********************************/
-/** \brief Channel datatype  
-    \ingroup m_datatypes_management 
     A <em>channel</em>  is a number and identifies a mailbox type (just as a 
     port number does).
     \see m_channel_management
-*/
+   @{ */
 typedef int m_channel_t;
+/** @} */
 
-/****************************** Error handling *******************************/
-/** \brief Error handling
-*/typedef enum {
-  MSG_OK = 0,  /**< Everything is right. Keep on going this way ! */
-  MSG_WARNING, /**< Mmmh! Something must be not perfectly clean. But I
+/* ***************************** Error handling ***************************** */
+/** @brief Error handling 
+    @ingroup m_datatypes_management 
+    @{
+*/
+typedef enum {
+  MSG_OK = 0,  /**< @brief Everything is right. Keep on going this way ! */
+  MSG_WARNING, /**< @brief Mmmh! Something must be not perfectly clean. But I
       may be a paranoid freak... ! */
-  MSG_TRANSFER_FAILURE, /**< There has been a problem during you task
+  MSG_TRANSFER_FAILURE, /**< @brief There has been a problem during you task
       transfer. Either the network is down or the remote host has been
       shutdown. */
-  MSG_HOST_FAILURE, /**< System shutdown. The host on which you are
+  MSG_HOST_FAILURE, /**< @brief System shutdown. The host on which you are
       running has just been rebooted. Free your datastructures and
       return now !*/
-  MSG_FATAL /**< You've done something wrong. You'd better look at it... */
+  MSG_TASK_CANCELLED, /**< @brief Cancelled task. This task has been cancelled 
+			by somebody!*/
+  MSG_FATAL /**< @brief You've done something wrong. You'd better look at it... */
 } MSG_error_t;
+/** @} */
 
-typedef enum {
-  MSG_SILENT = 0,
-  MSG_SOME,
-  MSG_VERBOSE
-} MSG_outputmode_t;
-
-typedef enum {
-  MSG_STORE_AND_FORWARD = 1, /* 0 means uninitialized value */
-  MSG_TCP
-} MSG_sharing_t;
-
-/************************ deprecated *****************************************/
-/* /\********************************* Link **************************************\/ */
-/* struct s_m_link { */
-/*   char *name;			/\* link name if any *\/ */
-/*   void *simdata;		/\* simulator data *\/ */
-/*   void *data;			/\* user data *\/ */
-/* }; */
-
-/* /\** \brief Link datatype   */
-/*     \ingroup m_datatypes_management */
-
-/*     A <em>link</em> is an agglomeration of communicating resources */
-/*     representing a set of physical network links. */
-
-/*     \see m_link_management */
-/* *\/ */
-/* typedef struct s_m_link *m_link_t; */
-
+SG_END_DECL()
 #endif