Delete some warning during the ref_guide build

diff --git a/doc/ref_guide/doxygen/RefGuideDoxyfile.in b/doc/ref_guide/doxygen/RefGuideDoxyfile.in
index eb95cf3..8e9a5d7 100644 (file)
--- a/doc/ref_guide/doxygen/RefGuideDoxyfile.in
+++ b/doc/ref_guide/doxygen/RefGuideDoxyfile.in
@@ -668,7 +668,7 @@ INPUT                  = main.doc \
                          module-surf.doc \
                          module-simix.doc \
                          module-trace.doc \
-                        index-API.doc \
+                         index-API.doc \
                          @top_srcdir@/doc/ref_guide/doxygen/logcategories.doc \
                          @top_srcdir@/src/instr/ \
                          @top_srcdir@/include/ \

diff --git a/doc/ref_guide/doxygen/module-msg.doc b/doc/ref_guide/doxygen/module-msg.doc
index d32230c..70b7f6b 100644 (file)
--- a/doc/ref_guide/doxygen/module-msg.doc
+++ b/doc/ref_guide/doxygen/module-msg.doc
@@ -17,6 +17,7 @@
    - \ref m_process_management
    - \ref m_host_management
    - \ref m_task_management
+   - \ref m_mailbox_management
    - \ref msg_file_management
    - \ref msg_task_usage
    - \ref msg_VMs
@@ -44,8 +45,6 @@ details).
     #MSG_function_register (and maybe #MSG_function_register_default)
  -# Launch your processes from a deployment file with #MSG_launch_application
  -# Run the simulation with #MSG_main
- -# Cleanup the library with #MSG_clean before ending your program
-    (optional).
 
 @htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Simulation Control" --> @endhtmlonly
 */
@@ -70,6 +69,14 @@ details).
  * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Tasks" --> \endhtmlonly
  */
 
+/** @defgroup m_mailbox_management Mailbox Management Functions
+ *  @ingroup MSG_API
+ *  @brief This section describes the mailbox structure of MSG
+ *         (#msg_mailbox_t) and the functions for managing it.
+ *
+ * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Tasks" --> \endhtmlonly
+ */
+
 /** @defgroup msg_task_usage Task Actions
  *  @ingroup MSG_API
  *  @brief This section describes the functions that can be used

diff --git a/include/xbt/file_stat.h b/include/xbt/file_stat.h
index 7bdd3ac..f7c15ce 100644 (file)
--- a/include/xbt/file_stat.h
+++ b/include/xbt/file_stat.h
@@ -10,6 +10,10 @@
 
 #include "xbt/sysdep.h"
 
+/* \ingroup msg_file_management
+ * \brief Structure containing information of a file
+ *
+ */
 typedef struct file_stat {
   char *user_rights;
   char *user;

diff --git a/src/msg/msg_mailbox.c b/src/msg/msg_mailbox.c
index 984df9d..45207d6 100644 (file)
--- a/src/msg/msg_mailbox.c
+++ b/src/msg/msg_mailbox.c
@@ -9,6 +9,10 @@
 #include "msg_mailbox.h"
 #include "msg_private.h"
 
+/** @addtogroup m_mailbox_management
+ *  \brief functions to manage mailbox
+ */
+
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_mailbox, msg,
                                 "Logging specific to MSG (mailbox)");
 
@@ -64,6 +68,18 @@ void MSG_mailbox_set_async(const char *alias){
 
 }
 
+/* \ingroup m_mailbox_management
+ * \brief Get a task from a mailbox on a given host
+ *
+ * \param mailbox The mailbox where the task was sent
+ * \param task a memory location for storing a #msg_task_t.
+ * \param host a #msg_host_t host from where the task was sent
+ * \param timeout a timeout
+
+ * \return Returns
+ * #MSG_OK if the task was successfully received,
+ * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
+ */
 msg_error_t
 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
                          msg_host_t host, double timeout)

diff --git a/src/simix/smx_user.c b/src/simix/smx_user.c
index 7f32016..a6415b5 100644 (file)
--- a/src/simix/smx_user.c
+++ b/src/simix/smx_user.c
@@ -80,7 +80,7 @@ xbt_dict_t simcall_host_get_properties(smx_host_t host)
  * \ingroup simix_host_management
  * \brief Returns a dict of the properties assigned to a router or AS.
  *
- * \param asr name of the router or AS
+ * \param name The name of the router or AS
  * \return The properties
  */
 xbt_dict_t simcall_asr_get_properties(const char *name)

diff --git a/src/xbt/xbt_replay.c b/src/xbt/xbt_replay.c
index 7cf78b0..6b71973 100644 (file)
--- a/src/xbt/xbt_replay.c
+++ b/src/xbt/xbt_replay.c
@@ -88,7 +88,7 @@ void xbt_replay_reader_free(xbt_replay_reader_t *reader)
  * \brief Registers a function to handle a kind of action
  *
  * Registers a function to handle a kind of action
- * This table is then used by #xbt_replay_action_runner
+ * This table is then used by \ref xbt_replay_action_runner
  *
  * The argument of the function is the line describing the action, splitted on spaces with xbt_str_split_quoted()
  *
@@ -123,6 +123,13 @@ void _xbt_replay_action_exit(void)
   free(action_line);
 }
 
+/**
+ * \ingroup XBT_replay
+ * \brief TODO
+
+ * \param argc argc .
+ * \param argv argv
+ */
 int xbt_replay_action_runner(int argc, char *argv[])
 {
   const char **evt;