X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/36dffb4f8633c75ddaf66e398f432a8485e9e419..a4b0a684c019c3c69ccace47ad12d34258785a44:/doc/module-msg.doc?ds=sidebyside diff --git a/doc/module-msg.doc b/doc/module-msg.doc index e5c554933b..d94fd0d3ce 100644 --- a/doc/module-msg.doc +++ b/doc/module-msg.doc @@ -17,15 +17,13 @@ - \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_easier_life - \ref msg_simulation - \section MSG_examples Examples of MSG - - - \ref MSG_ex_master_slave - - \ref MSG_ex_asynchronous_communications - - \ref MSG_ex_master_slave_scrip_lua + Also make sure to visit the page @ref MSG_examples. */ @@ -52,7 +50,19 @@ * @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 @@ -66,16 +76,27 @@ * MSG_examples for an overview of their usage. */ -/** -@defgroup msg_simulation MSG simulation Functions +/** @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 @endhtmlonly +*/ + +/** +@defgroup MSG_examples MSG Examples @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. + +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 -@htmlonly @endhtmlonly */ - + /** @defgroup MSG_LUA Lua bindings @ingroup MSG_API @@ -109,12 +130,13 @@ - \ref MSG_ex_master_slave_lua - \ref MSG_ex_master_slave_lua_bypass - - Also, the Chord example (in the source tree) is a working - non-trivial example of use of the lua bindings + - Also, the lua version of the Chord example (in the source tree) + is a working non-trivial example of use of the lua bindings */ -/** \page MSG_ex_asynchronous_communications Asynchronous communication applications +/** \defgroup MSG_ex_asynchronous_communications Asynchronous communications + \ingroup MSG_examples Simulation of asynchronous communications between a sender and a receiver using a realistic platform and an external description of the deployment. @@ -221,89 +243,8 @@ */ -/** \page MSG_ex_master_slave_scrip_lua Master/slave application using lua console - - Simulation of a master-slave application using a realistic platform and - an external description of the deployment via a lua script. - - \section MSG_ex_msl_TOC Table of contents: - - - \ref MSG_ext_msl_code - - \ref MSG_ext_msl_preliminary - - \ref MSG_ext_msl_master - - \ref MSG_ext_msl_slave - - \ref MSG_ext_msl_core - - \ref MSG_ext_msl_main - - \ref MSG_ext_msl_helping - - \ref MSG_ext_msl_platform - -