From: Martin Quinson <martin.quinson@loria.fr>
Date: Wed, 4 Apr 2012 04:30:17 +0000 (-1000)
Subject: [DOC] kill the datatype specific page
X-Git-Tag: v3_7~114
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/b8e77688484ef873583e285d34c7b85ddce9294c

[DOC] kill the datatype specific page

all the data are now in their home module, alongside with the function
modifying them.
---

diff --git a/doc/module-msg.doc b/doc/module-msg.doc
index e6282dde3c..31ebd24b73 100644
--- a/doc/module-msg.doc
+++ b/doc/module-msg.doc
@@ -15,7 +15,6 @@
   \section MSG_funct Offered functionnalities
    - \ref msg_simulation
    - \ref m_process_management
-   - \ref m_datatypes_management
    - \ref m_host_management
    - \ref m_task_management
    - \ref msg_file_management
@@ -62,14 +61,6 @@ details).
 @htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Simulation Control" --> @endhtmlonly
 */
 
-
-/** @defgroup m_datatypes_management MSG Data Types 
-    @ingroup MSG_API
-    @brief This section describes the different datatypes provided by MSG.
-    
-    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Data types" --> \endhtmlonly
-*/
-
 /** @defgroup m_process_management Process Management Functions 
  *  @ingroup MSG_API
  *  @brief This section describes the process structure of MSG
diff --git a/include/msg/datatypes.h b/include/msg/datatypes.h
index b081c6b438..08a6b2626d 100644
--- a/include/msg/datatypes.h
+++ b/include/msg/datatypes.h
@@ -101,10 +101,9 @@ typedef struct m_gpu_task *m_gpu_task_t;
 
 /**
  * \brief @brief Communication action.
- * \ingroup m_datatypes_management
+ * \ingroup msg_task_usage
  *
- * Communication actions transfer tasks between processes.
- * For a given task, the sender and the receiver have distinct objects.
+ * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
  */
 typedef struct msg_comm *msg_comm_t;
 
@@ -134,8 +133,15 @@ typedef int m_channel_t;
 /* ******************************** Mailbox ************************************ */
 
 /** @brief Mailbox datatype
-    @ingroup m_datatypes_management
- */
+ *  @ingroup msg_task_usage
+ * 
+ * Object representing a communication rendez-vous point, on which
+ * the sender finds the receiver it wants to communicate with. As a
+ * MSG user, you will only rarely manipulate any of these objects
+ * directly, since most of the public interface (such as
+ * #MSG_task_send and friends) hide this object behind a string
+ * alias. That mean that you don't provide the mailbox on which you
+ * want to send your task, but only the name of this mailbox. */
 typedef struct s_smx_rvpoint *msg_mailbox_t;