Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix typo
[simgrid.git] / doc / ref_guide / doxygen / module-msg.doc
index 695efec..b6de29e 100644 (file)
@@ -17,6 +17,7 @@
    - \ref m_process_management
    - \ref m_host_management
    - \ref m_task_management
+   - \ref msg_mailbox_management
    - \ref msg_file_management
    - \ref msg_task_usage
    - \ref msg_VMs
 The basic workflow is the following (check the \ref MSG_examples for
 details).
 
- -# Initialize the library with #MSG_global_init
+ -# Initialize the library with #MSG_init
  -# Create a platform (usually by parsing a file with
     #MSG_create_environment)
  -# Register the functions that your processes are supposed to run with
     #MSG_function_register (and maybe #MSG_function_register_default)
  -# Launch your processes from a deployment file with #MSG_launch_application
  -# Run the simulation with #MSG_main
- -# Cleanup the library with #MSG_clean before ending your program
-    (optional).
 
 @htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Simulation Control" --> @endhtmlonly
 */
@@ -53,7 +52,7 @@ details).
 /** @defgroup m_process_management Process Management Functions
  *  @ingroup MSG_API
  *  @brief This section describes the process structure of MSG
- *         (#m_process_t) and the functions for managing it.
+ *         (#msg_process_t) and the functions for managing it.
  */
 
 /** @defgroup m_host_management Host Management Functions
@@ -64,12 +63,20 @@ details).
 /** @defgroup m_task_management Task Management Functions
  *  @ingroup MSG_API
  *  @brief This section describes the task structure of MSG
- *         (#m_task_t) and the functions for managing it. See
+ *         (#msg_task_t) and the functions for managing it. See
  *         \ref msg_task_usage to see how to put the tasks in action.
  *
  * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Tasks" --> \endhtmlonly
  */
 
+/** @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.
+ *
+ * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Mailbox" --> \endhtmlonly
+ */
+
 /** @defgroup msg_task_usage Task Actions
  *  @ingroup MSG_API
  *  @brief This section describes the functions that can be used
@@ -116,7 +123,7 @@ there is no such event.
 In such situations, SimGrid allows to write your protocol in your C
 file, and the events to react to in a separate text file. Declare a
 function handling each of the events that you want to accept in your
-trace files, register them using #MSG_action_register in your main,
+trace files, register them using #xbt_replay_action_register in your main,
 and then use #MSG_action_trace_run to launch the simulation. You can
 either have one trace file containing all your events, or a file per
 simulated process.