Fix documentation warnings

diff --git a/doc/ref_guide/doxygen/module-msg.doc b/doc/ref_guide/doxygen/module-msg.doc
index 70b7f6b..b6de29e 100644 (file)
--- a/doc/ref_guide/doxygen/module-msg.doc
+++ b/doc/ref_guide/doxygen/module-msg.doc
@@ -17,7 +17,7 @@
    - \ref m_process_management
    - \ref m_host_management
    - \ref m_task_management
-   - \ref m_mailbox_management
+   - \ref msg_mailbox_management
    - \ref msg_file_management
    - \ref msg_task_usage
    - \ref msg_VMs
@@ -69,12 +69,12 @@ details).
  * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Tasks" --> \endhtmlonly
  */
 
-/** @defgroup m_mailbox_management Mailbox Management Functions
+/** @defgroup msg_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
+ * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Mailbox" --> \endhtmlonly
  */
 
 /** @defgroup msg_task_usage Task Actions

diff --git a/include/msg/datatypes.h b/include/msg/datatypes.h
index 483c582..598ea84 100644 (file)
--- a/include/msg/datatypes.h
+++ b/include/msg/datatypes.h
@@ -89,6 +89,12 @@ typedef struct msg_file {
  */
 typedef struct msg_file *msg_file_t;
 
+
+/** @brief File datatype.
+    @ingroup msg_file_management
+
+    You should consider this as an opaque object.
+ */
 typedef s_file_stat_t s_msg_stat_t, *msg_stat_t;
 
 

diff --git a/include/xbt/file_stat.h b/include/xbt/file_stat.h
index f7c15ce..4e323dc 100644 (file)
--- a/include/xbt/file_stat.h
+++ b/include/xbt/file_stat.h
@@ -10,9 +10,8 @@
 
 #include "xbt/sysdep.h"
 
-/* \ingroup msg_file_management
- * \brief Structure containing information of a file
- *
+/** \ingroup msg_file_management
+  \brief Strucure containing information on file like stat on POSIX
  */
 typedef struct file_stat {
   char *user_rights;

diff --git a/src/msg/msg_gos.c b/src/msg/msg_gos.c
index a883deb..9f2156e 100644 (file)
--- a/src/msg/msg_gos.c
+++ b/src/msg/msg_gos.c
@@ -164,7 +164,7 @@ msg_error_t MSG_process_sleep(double nb_sec)
  *    sometime waiting on all these mailboxes using @ref MSG_comm_waitany. You can find
  *    an example of use of this function in the @ref MSG_examples section.
  *  - Provide a proper patch to implement this functionality back in MSG. That wouldn't be
- *    very difficult actually. Check the function #MSG_mailbox_get_task_ext. During its call to
+ *    very difficult actually. Check the function @ref MSG_mailbox_get_task_ext. During its call to
  *    simcall_comm_recv(), the 5th argument, match_fun, is NULL. Create a function that filters
  *    messages according to the host (that you will pass as sixth argument to simcall_comm_recv()
  *    and that your filtering function will receive as first parameter, and then, the filter could

diff --git a/src/msg/msg_mailbox.c b/src/msg/msg_mailbox.c
index 45207d6..1edc135 100644 (file)
--- a/src/msg/msg_mailbox.c
+++ b/src/msg/msg_mailbox.c
@@ -9,10 +9,6 @@
 #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)");
 
@@ -68,7 +64,7 @@ void MSG_mailbox_set_async(const char *alias){
 
 }
 
-/* \ingroup m_mailbox_management
+/** \ingroup msg_mailbox_management
  * \brief Get a task from a mailbox on a given host
  *
  * \param mailbox The mailbox where the task was sent