From: Martin Quinson <martin.quinson@loria.fr>
Date: Thu, 19 May 2016 11:55:23 +0000 (+0200)
Subject: fix some doxygen formating problems
X-Git-Tag: v3_14~1205
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/5a9c845da2c148a5e6319c698b0e539ee3351164

fix some doxygen formating problems
---

diff --git a/src/simix/Context.cpp b/src/simix/Context.cpp
index f86acfdf6c..a780e56745 100644
--- a/src/simix/Context.cpp
+++ b/src/simix/Context.cpp
@@ -28,7 +28,6 @@ void SIMIX_process_set_cleanup_function(
  * \param argc the number of arguments of the main function
  * \param argv the vector of arguments of the main function
  * \param cleanup_func the function to call when the context stops
- * \param cleanup_arg the argument of the cleanup_func function
  */
 smx_context_t SIMIX_context_new(
   xbt_main_func_t code, int argc, char **argv,
diff --git a/src/simix/smx_network.cpp b/src/simix/smx_network.cpp
index c4e14645ff..ebccbd1a17 100644
--- a/src/simix/smx_network.cpp
+++ b/src/simix/smx_network.cpp
@@ -84,7 +84,7 @@ void SIMIX_mbox_set_receiver(smx_mailbox_t mbox, smx_process_t process)
 /**
  *  \brief Pushes a communication synchro into a rendez-vous point
  *  \param mbox The mailbox
- *  \param comm The communication synchro
+ *  \param synchro The communication synchro
  */
 static inline void SIMIX_mbox_push(smx_mailbox_t mbox, smx_synchro_t synchro)
 {
@@ -97,7 +97,7 @@ static inline void SIMIX_mbox_push(smx_mailbox_t mbox, smx_synchro_t synchro)
 /**
  *  \brief Removes a communication synchro from a rendez-vous point
  *  \param mbox The rendez-vous point
- *  \param comm The communication synchro
+ *  \param synchro The communication synchro
  */
 void SIMIX_mbox_remove(smx_mailbox_t mbox, smx_synchro_t synchro)
 {
diff --git a/src/simix/smx_vm.cpp b/src/simix/smx_vm.cpp
index ae5fdbd923..e74974f444 100644
--- a/src/simix/smx_vm.cpp
+++ b/src/simix/smx_vm.cpp
@@ -358,19 +358,19 @@ void simcall_HANDLER_vm_shutdown(smx_simcall_t simcall, sg_host_t ind_vm)
 /**
  * \brief Function to destroy a SIMIX VM host.
  *
- * \param host the vm host to destroy (a sg_host_t)
+ * \param vm the vm host to destroy (a sg_host_t)
  */
-void SIMIX_vm_destroy(sg_host_t ind_vm)
+void SIMIX_vm_destroy(sg_host_t vm)
 {
   /* this code basically performs a similar thing like SIMIX_host_destroy() */
 
-  const char *hostname = sg_host_get_name(ind_vm);
+  const char *hostname = sg_host_get_name(vm);
 
   XBT_DEBUG("destroy %s", hostname);
 
   /* this will call the registered callback function, i.e., SIMIX_host_destroy().  */
-  sg_host_simix_destroy(ind_vm);
+  sg_host_simix_destroy(vm);
 
   /* jump to vm_ws_destroy(). The surf level resource will be freed. */
-  surf_vm_destroy(ind_vm);
+  surf_vm_destroy(vm);
 }
diff --git a/src/smpi/smpi_dvfs.cpp b/src/smpi/smpi_dvfs.cpp
index 1ab64e03a2..5b1876e29c 100644
--- a/src/smpi/smpi_dvfs.cpp
+++ b/src/smpi/smpi_dvfs.cpp
@@ -50,11 +50,7 @@ void smpi_set_host_pstate(int pstate_index)
 {
   sg_host_set_pstate(SIMIX_host_self(), pstate_index);
 }
-/**
- * \brief Gets the pstate at which the processor currently running
- *
- * \param pstate_index pstate to switch to
- */
+/** @brief Gets the pstate at which the processor currently running */
 int smpi_get_host_pstate() {
   return sg_host_get_pstate(SIMIX_host_self());
 }