From: Martin Quinson <martin.quinson@loria.fr>
Date: Mon, 18 Apr 2011 15:34:48 +0000 (+0200)
Subject: further doxygen fixes (I'll try to stop for today)
X-Git-Tag: v3.6_beta2~21
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/4c5e4b83e02a8e003c4e5067476649dce17df103

further doxygen fixes (I'll try to stop for today)
---

diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 3e03278dbf..9b43be70bf 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -503,7 +503,7 @@ INPUT                  = index.doc \
 			    gtut-howto.doc \
 			        gtut-howto-design.doc \
                          \
-                         ./logcategories.doc \
+                         @top_srcdir@/doc/logcategories.doc \
 			 \
                          @top_srcdir@/include/ \
                          @top_srcdir@/include/msg \
@@ -524,7 +524,6 @@ INPUT                  = index.doc \
                          @top_srcdir@/src/amok/Bandwidth \
                          @top_srcdir@/src/amok/PeerManagement \
                          @top_srcdir@/src/simdag \
-                         @top_srcdir@/src/java/simgrid/msg
 
 # This tag can be used to specify the character encoding of the source files that 
 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 
diff --git a/doc/FAQ.doc b/doc/FAQ.doc
index bd3afe7ff8..dd73b3f466 100644
--- a/doc/FAQ.doc
+++ b/doc/FAQ.doc
@@ -2365,7 +2365,7 @@ MSG.exit
 
 \subsubsection faq_binding_ruby_data Exchanging data 
 ruby bindings provides two ways to exchange data between ruby processes.
-\li MSG::Task.join & MSG::Task.data \br
+\li MSG::Task.join & MSG::Task.data <br/>
 
   the MSG::Task class contains 2 methods that allows a data exchange between 2 process.
   
diff --git a/doc/gtut-tour-08-exceptions.doc b/doc/gtut-tour-08-exceptions.doc
index 90dce052d9..6a9c15c525 100644
--- a/doc/gtut-tour-08-exceptions.doc
+++ b/doc/gtut-tour-08-exceptions.doc
@@ -60,7 +60,7 @@ Then, you simply add a #TRY/#CATCH block around your code:
 
 Another strange thing is that you should actually free the memory allocated
 to the exception with xbt_ex_fres() if you manage to deal with them. There
-is a bit more than this on the picture (#CLEANUP blocks, for example), and
+is a bit more than this on the picture (#TRY_CLEANUP blocks, for example), and
 you should check the section \ref XBT_ex for more details.
 
 You should be <b>very carfull</b> when using the exceptions. They work great
diff --git a/include/gras/process.h b/include/gras/process.h
index 90777142a4..5cf7a16e18 100644
--- a/include/gras/process.h
+++ b/include/gras/process.h
@@ -21,7 +21,7 @@ SG_BEGIN_DECL()
 void gras_agent_spawn(const char *name, xbt_main_func_t code,
                       int argc, char *argv[], xbt_dict_t properties);
 
-/** }@ */
+/** @} */
 
 /****************************************************************************/
 /* Manipulating User Data                                                   */
diff --git a/include/xbt/log.h b/include/xbt/log.h
index 6181f59250..790295e941 100644
--- a/include/xbt/log.h
+++ b/include/xbt/log.h
@@ -430,8 +430,7 @@ extern xbt_log_layout_t xbt_log_default_layout;
 /** @ingroup XBT_log
  *  @hideinitializer
  * \param c the category on which to log
- * \param f the format string
- * \param ... arguments of the format
+ * \param ... the format string and its arguments
  *  @brief Log an event at the DEBUG priority on the specified category with these args.
  */
 #define XBT_CDEBUG(c, ...) XBT_CLOG(c, xbt_log_priority_debug, __VA_ARGS__)
@@ -468,8 +467,7 @@ extern xbt_log_layout_t xbt_log_default_layout;
 
 /** @ingroup XBT_log
  *  @hideinitializer
- * \param f the format string
- * \param ...
+ * \param ... the format string and its arguments
  *  @brief Log an event at the DEBUG priority on the default category with these args.
  */
 #define XBT_DEBUG(...) XBT_LOG(xbt_log_priority_debug, __VA_ARGS__)
diff --git a/include/xbt/sysdep.h b/include/xbt/sysdep.h
index d05639b575..adc9022a9f 100644
--- a/include/xbt/sysdep.h
+++ b/include/xbt/sysdep.h
@@ -35,7 +35,7 @@ SG_BEGIN_DECL()
 
 /**
  * @brief Kill the program with an error message
- * \param msg
+ * \param ... a format string and its arguments
  *
  * Things are so messed up that the only thing to do now, is to stop the
  * program.
diff --git a/src/msg/gos.c b/src/msg/gos.c
index 7d929e1376..4a09c655dd 100644
--- a/src/msg/gos.c
+++ b/src/msg/gos.c
@@ -486,9 +486,9 @@ void MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup)
  * \param name of the mailbox to receive the task on
  * \return the msg_comm_t communication created
  */
-msg_comm_t MSG_task_irecv(m_task_t *task, const char *alias)
+msg_comm_t MSG_task_irecv(m_task_t *task, const char *name)
 {
-  smx_rdv_t rdv = MSG_mailbox_get_by_alias(alias);
+  smx_rdv_t rdv = MSG_mailbox_get_by_alias(name);
 
   CHECK_HOST();
 
diff --git a/src/simdag/sd_task.c b/src/simdag/sd_task.c
index 555f6efb7e..9735f36dfd 100644
--- a/src/simdag/sd_task.c
+++ b/src/simdag/sd_task.c
@@ -746,7 +746,7 @@ static XBT_INLINE void SD_task_do_schedule(SD_task_t task)
  * i.e. when its dependencies are satisfied.
  *
  * \param task the task you want to schedule
- * \param workstation_nb number of workstations on which the task will be executed
+ * \param workstation_count number of workstations on which the task will be executed
  * \param workstation_list the workstations on which the task will be executed
  * \param computation_amount computation amount for each workstation
  * \param communication_amount communication amount between each pair of workstations