various MSG doc cleanups

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

diff --git a/doc/module-msg.doc b/doc/module-msg.doc
index d94fd0d..5db1732 100644 (file)
--- a/doc/module-msg.doc
+++ b/doc/module-msg.doc
@@ -20,12 +20,34 @@
    - \ref m_file_management
    - \ref msg_actions_functions
    - \ref msg_gos_functions
+   - \ref msg_deprecated_functions
    - \ref msg_easier_life
    - \ref msg_simulation
 
   Also make sure to visit the page @ref MSG_examples.
 */
 
+/**
+@defgroup MSG_examples MSG Examples
+@ingroup MSG_API
+ 
+MSG comes with an extensive set of examples. It is sometimes difficult
+to find the one you need. This list aims at helping you finding the
+example from which you can learn what you want to.
+
+@section MSG_ex_basics Basic examples and features
+
+*/
+
+/** @defgroup msg_simulation   Main MSG simulation Functions
+*      @ingroup MSG_API
+*      @brief This section describes the functions you need to know to
+*       set up a simulation. You should have a look at \ref MSG_examples
+*       to have an overview of their usage.
+*
+*      @htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Simulation control" --> @endhtmlonly
+*/
+
 
 /** @defgroup m_datatypes_management MSG Data Types 
     @ingroup MSG_API
@@ -34,24 +56,24 @@
     \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Data types" --> \endhtmlonly
 */
 
-/** @defgroup m_process_management Management Functions of Agents
+/** @defgroup m_process_management Process Management Functions 
  *  @ingroup MSG_API
- *  @brief This section describes the agent structure of MSG
+ *  @brief This section describes the process structure of MSG
  *         (#m_process_t) and the functions for managing it.
  */
    
-/** @defgroup m_host_management Management functions of Hosts
+/** @defgroup m_host_management Host Management Functions
  *  @ingroup MSG_API
  *  @brief This section describes the host structure of MSG
  */
   
-/** @defgroup m_task_management Managing functions of Tasks
+/** @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.
  */
  
- /** @defgroup m_file_management Managing functions of Files
+ /** @defgroup m_file_management File Management Functions
  *  @ingroup MSG_API
  *  @brief This section describes the file structure of MSG
  *         (#m_file_t) and the functions for managing it. It
@@ -62,13 +84,13 @@
  *  @ingroup MSG_API
  *  @brief This section describes functions for managing actions.
  */ 
- 
+
 /** @defgroup msg_gos_functions MSG Operating System Functions
  *  @ingroup MSG_API
  *  @brief This section describes the functions that can be used
- *         by an agent for handling some task.
+ *         by a process for handling some task.
  */
-
+ 
 /** @defgroup msg_easier_life      Platform and Application management
  *  @ingroup MSG_API
  *  @brief This section describes functions to manage the platform creation
@@ -76,27 +98,6 @@
  *         MSG_examples for an overview of their usage. 
  */
  
-/** @defgroup msg_simulation   MSG simulation Functions
-*      @ingroup MSG_API
-*      @brief This section describes the functions you need to know to
-*       set up a simulation. You should have a look at \ref MSG_examples
-*       to have an overview of their usage.
-*
-*      @htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Simulation functions" --> @endhtmlonly
-*/
-
-/**
-@defgroup MSG_examples MSG Examples
-@ingroup MSG_API
- 
-MSG comes with an extensive set of examples. It is sometimes difficult
-to find the one you need. This list aims at helping you finding the
-example from which you can learn what you want to.
-
-@section MSG_ex_basics Basic examples and features
-
-*/
-
 /**
 @defgroup MSG_LUA      Lua bindings
 @ingroup MSG_API
@@ -134,6 +135,14 @@ example from which you can learn what you want to.
      is a working non-trivial example of use of the lua bindings
 */
 
+/** @defgroup msg_deprecated_functions MSG Deprecated
+ *  @ingroup MSG_API
+ *  @brief This section describes the deprecated functions and. They
+ *     should be remove on next release.
+ */
+ 
+
+
 
 /** \defgroup MSG_ex_asynchronous_communications Asynchronous communications
     \ingroup MSG_examples
@@ -200,7 +209,7 @@ example from which you can learn what you want to.
       thanks to MSG_create_environment() and MSG_launch_application().
          -# Simulation settings : MSG_create_environment() creates a realistic 
             environment
-         -# Application deployment : create the agents on the right locations with  
+         -# Application deployment : create the processes on the right locations with  
             MSG_launch_application()
          -# The simulation is run with #MSG_main()
         
@@ -319,7 +328,7 @@ example from which you can learn what you want to.
       thanks to MSG_create_environment() and MSG_launch_application().
          -# Simulation settings : MSG_create_environment() creates a realistic 
             environment
-         -# Application deployment : create the agents on the right locations with  
+         -# Application deployment : create the processes on the right locations with  
             MSG_launch_application()
          -# The simulation is run with #MSG_main()
         
@@ -392,7 +401,7 @@ example from which you can learn what you want to.
       
          -# Simulation settings : <i>simgrid.platform</i> creates a realistic 
             environment 
-         -# Application deployment : create the agents on the right locations with  
+         -# Application deployment : create the processes on the right locations with  
             <i>simgrid.application</i>
          -# The simulation is run with <i>simgrid.run</i>