new doc: how to model multicores

[simgrid.git] / doc / doxygen / module-msg.doc

diff --git a/doc/doxygen/module-msg.doc b/doc/doxygen/module-msg.doc
index b63e181..8f4ae03 100644 (file)
--- a/doc/doxygen/module-msg.doc
+++ b/doc/doxygen/module-msg.doc
@@ -1,5 +1,5 @@
 /**
-@page MSG_API  MSG: Simple API for CSP Algorithms
+@defgroup MSG_API  MSG: Simulate CSP Algorithms
 @brief Simple programming environment
 
 MSG is a simple API to write algorithms organized with Concurrent
@@ -27,16 +27,16 @@ may want to use one of the following:
    - \ref msg_VMs
    - \ref msg_synchro
    - \ref msg_trace_driven
-   - \ref MSG_examples
+   - \ref msg_examples
 
 */ 
 
 /**
 @defgroup msg_simulation   Main MSG simulation Functions
 @ingroup MSG_API
-@brief Describes how to setup and control your simulation.
+@brief How to setup and control your simulation.
 
-The basic workflow is the following (check the \ref MSG_examples for
+The basic workflow is the following (check the \ref msg_examples for
 details).
 
  -# Initialize the library with #MSG_init
@@ -56,20 +56,18 @@ details).
 
 /** @defgroup m_host_management Host Management Functions
  *  @ingroup MSG_API
- *  @brief This section describes the host structure of MSG
+ *  @brief Host structure of MSG
  */
 
 /** @defgroup m_task_management Task Management Functions
  *  @ingroup MSG_API
- *  @brief This section describes the task structure of MSG
- *         (#msg_task_t) and the functions for managing it. See
+ *  @brief Task structure of MSG (#msg_task_t) and associated functions. See
  *         \ref msg_task_usage to see how to put the tasks in action.
  */
 
 /** @defgroup msg_mailbox_management Mailbox Management Functions
  *  @ingroup MSG_API
- *  @brief This section describes the mailbox structure of MSG
- *         (#msg_mailbox_t) and the functions for managing it.
+ *  @brief Functions associated to mailboxes.
  */
 
 /** @defgroup msg_task_usage Task Actions
@@ -80,15 +78,14 @@ details).
 
 /** @defgroup msg_synchro Explicit Synchronization Functions
  *  @ingroup MSG_API
- *  @brief This section describes several explicit synchronization
- *         mechanisms existing in MSG: semaphores (#msg_sem_t) and friends.
+ *  @brief Explicit synchronization mechanisms: semaphores (#msg_sem_t) and friends.
  *
  * In some situations, these things are very helpful to synchronize processes without message exchanges.
  */
 
 /** @defgroup msg_VMs VMs
  *  @ingroup MSG_API
- *  @brief This section describes the interface created to mimic IaaS clouds.
+ *  @brief Interface created to mimic IaaS clouds.
  *
  *  With it, you can create virtual machines to put your processes
  *  into, and interact directly with the VMs to manage groups of
@@ -105,14 +102,12 @@ details).
 
 /** @defgroup msg_storage_management Storage Management Functions
  *  @ingroup MSG_API
- *  @brief This section describes the storage structure of MSG
- *         (#msg_storage_t) and the functions for managing it. It
- *   is based on POSIX functions.
+ *  @brief Storage structure of MSG (#msg_storage_t) and associated functions, inspired from POSIX.
  */
 
 /** @defgroup msg_file File Management Functions
     @ingroup MSG_API
-    @brief MSG files (#msg_file_t) and associated functions, inspired from POSIX file handling.
+    @brief MSG files (#msg_file_t) and associated functions, inspired from POSIX.
 */
 
 /**