Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
the word agent seems a bit artificial in our documentation, when you think about it
[simgrid.git] / doc / module-msg.doc
index 77a857ce547c23da0f196f71d96d6bc9db17ca66..43443928def3018fd291a7b74b470917ac1b71f2 100644 (file)
    - \ref m_datatypes_management
    - \ref m_host_management
    - \ref m_task_management
+   - \ref m_file_management
+   - \ref msg_actions_functions
    - \ref msg_gos_functions
+   - \ref msg_deprecated_functions
    - \ref msg_easier_life
    - \ref msg_simulation
 
@@ -32,9 +35,9 @@
     \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Data types" --> \endhtmlonly
 */
 
-/** @defgroup m_process_management Management Functions of Agents
+/** @defgroup m_process_management Processes 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.
  */
    
  *  @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
+ *  @ingroup MSG_API
+ *  @brief This section describes the file structure of MSG
+ *         (#m_file_t) and the functions for managing it. It
+ *   is based on POSIX functions.
+ */ 
+/** @defgroup msg_actions_functions Managing actions
+ *  @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_deprecated_functions MSG Deprecated
+ *  @ingroup MSG_API
+ *  @brief This section describes the deprecated functions and. They
+ *     should be remove on next release.
+ */
 /** @defgroup msg_easier_life      Platform and Application management
  *  @ingroup MSG_API
  *  @brief This section describes functions to manage the platform creation
  *         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_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. 
+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
 
@@ -187,7 +207,7 @@ to find the one you need.
       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()
         
@@ -306,7 +326,7 @@ to find the one you need.
       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()
         
@@ -379,7 +399,7 @@ to find the one you need.
       
          -# 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>