X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ce565aba5d85be05fae86117fe73792a0bcbc0a4..3d629cbb40f2ce7ee2696b9fd650d3ca16fd67f2:/doc/module-msg.doc diff --git a/doc/module-msg.doc b/doc/module-msg.doc index 97700835f4..5ae5f6d171 100644 --- a/doc/module-msg.doc +++ b/doc/module-msg.doc @@ -1,4 +1,4 @@ -/** \addtogroup MSG_API +/** @addtogroup MSG_API \section MSG_funct Offered functionnalities - \ref m_process_management @@ -10,13 +10,17 @@ - \ref msg_easier_life - \ref msg_simulation - \section MSG_examples Examples of use + \section MSG_examples Examples of MSG - \ref MSG_ex_master_slave */ -/** \addtogroup m_datatypes_management - \ingroup MSG_API */ +/** @defgroup m_datatypes_management MSG Data Types + @ingroup MSG_API + @brief This section describes the different datatypes provided by MSG. + + \htmlonly \endhtmlonly +*/ /** \addtogroup m_process_management \ingroup MSG_API */ /** \addtogroup m_host_management @@ -54,7 +58,7 @@
- \dontinclude msg/msg_test.c + \dontinclude msg/masterslave/masterslave_forwarder.c \section MSG_ext_ms_code Code of the application @@ -85,7 +89,7 @@ \subsection MSG_ext_ms_slave Slave code This function has to be assigned to a #m_process_t that has to behave as a slave. - Just like #master(), it should not be called directly. + Just like the master fuction (described in \ref MSG_ext_ms_master), it should not be called directly. This function keeps waiting for tasks and executes them as it receives them. @@ -94,13 +98,15 @@ \subsection MSG_ext_ms_forwarder Forwarder code This function has to be assigned to a #m_process_t that has to behave as a forwarder. - Just like #master(), it should not be called directly. + Just like the master fuction (described in \ref MSG_ext_ms_master), it should not be called directly. C style arguments (argc/argv) are interpreted as a list of host that will accept those tasks. This function keeps waiting for tasks and dispathes them to its slaves. + \until end_of_forwarder + \subsection MSG_ext_ms_core Simulation core This function is the core of the simulation and is divided only into 3 parts @@ -127,7 +133,7 @@ \subsection MSG_ext_ms_application Example of application file - \include msg/small_deployment.xml + \include msg/masterslave/deployment_masterslave.xml \subsection MSG_ext_ms_platform Example of platform file