X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/abc6c695d534ee87fe91c84038ebbf6b9226575d..fb41bcf96de0ac14cce6f9f0aa9e5804c847bc9e:/doc/module-msg.doc diff --git a/doc/module-msg.doc b/doc/module-msg.doc index 77a857ce54..698d3f3e49 100644 --- a/doc/module-msg.doc +++ b/doc/module-msg.doc @@ -17,7 +17,10 @@ - \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 @@ -48,13 +51,31 @@ * @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. */ - + +/** @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 @@ -62,23 +83,22 @@ * 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 @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 @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