- \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
* @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
* 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
* In such situations, SimGrid allows to write your protocol in your
* C file, and the events to react to in a separate text file.
* Declare a function handling each of the events that you want to
- * accept in your trace files, register them using @ref
- * MSG_action_register in your main, and then use @ref
+ * accept in your trace files, register them using \ref
+ * MSG_action_register in your main, and then use \ref
* MSG_action_trace_run to launch the simulation. You can either
* have one trace file containing all your events, or a file per
* simulated process. Check the tesh files in the example directory
static const char **action_get_action(char *name);
-/** \ingroup msg_actions
+/** \ingroup msg_actions_functions
* \brief Registers a function to handle a kind of action
*
* Registers a function to handle a kind of action
*
* The argument of the function is the line describing the action, splitted on spaces with xbt_str_split_quoted()
*
- * \param name the reference name of the action.
- * \param code the function; prototype given by the type: void...(xbt_dynar_t action)
+ * \param action_name the reference name of the action.
+ * \param function prototype given by the type: void...(xbt_dynar_t action)
*/
void MSG_action_register(const char *action_name, msg_action_fun function)
{
xbt_dict_set(action_funs, action_name, function, NULL);
}
-/** \ingroup msg_actions
+/** \ingroup msg_actions_functions
* \brief Unregisters a function, which handled a kind of action
*
- * \param name the reference name of the action.
+ * \param action_name the reference name of the action.
*/
void MSG_action_unregister(const char *action_name)
{
return NULL;
}
-/** \ingroup msg_actions
+/** \ingroup msg_actions_functions
* \brief A trace loader
*
* If path!=NULL, load a trace file containing actions, and execute them.