fix some doxygen warnings

[simgrid.git] / src / simix / smx_network.cpp

diff --git a/src/simix/smx_network.cpp b/src/simix/smx_network.cpp
index 1c02f8c..ea92bfd 100644 (file)
--- a/src/simix/smx_network.cpp
+++ b/src/simix/smx_network.cpp
@@ -15,7 +15,7 @@
 #include "mc/mc.h"
 #include "simgrid/s4u/Activity.hpp"
 #include "simgrid/s4u/Mailbox.hpp"
-#include "src/mc/mc_replay.h"
+#include "src/mc/mc_replay.hpp"
 #include "src/simix/smx_private.hpp"
 #include "src/surf/cpu_interface.hpp"
 #include "src/surf/surf_interface.hpp"
@@ -30,7 +30,12 @@ static void SIMIX_comm_start(simgrid::kernel::activity::CommImplPtr synchro);
 
 /**
  *  \brief Checks if there is a communication activity queued in a deque matching our needs
+ *  \param deque where to search into
  *  \param type The type of communication we are looking for (comm_send, comm_recv)
+ *  \param match_fun the function to apply
+ *  \param this_user_data additional parameter to the match_fun
+ *  \param my_synchro what to compare against
+ *  \param remove_matching whether or not to clean the found object from the queue
  *  \return The communication activity if found, nullptr otherwise
  */
 static simgrid::kernel::activity::CommImplPtr
@@ -84,7 +89,7 @@ XBT_PRIVATE void simcall_HANDLER_comm_send(smx_simcall_t simcall, smx_actor_t sr
   simcall_HANDLER_comm_wait(simcall, comm, timeout);
 }
 XBT_PRIVATE smx_activity_t simcall_HANDLER_comm_isend(
-    smx_simcall_t simcall, smx_actor_t src_proc, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
+    smx_simcall_t /*simcall*/, smx_actor_t src_proc, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
     size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
     void (*clean_fun)(void*), // used to free the synchro in case of problem after a detached send
     void (*copy_data_fun)(smx_activity_t, void*, size_t), // used to copy data if not default one
@@ -163,8 +168,8 @@ XBT_PRIVATE void simcall_HANDLER_comm_recv(smx_simcall_t simcall, smx_actor_t re
   simcall_HANDLER_comm_wait(simcall, comm, timeout);
 }
 
-XBT_PRIVATE smx_activity_t simcall_HANDLER_comm_irecv(smx_simcall_t simcall, smx_actor_t receiver, smx_mailbox_t mbox,
-                                                      void* dst_buff, size_t* dst_buff_size,
+XBT_PRIVATE smx_activity_t simcall_HANDLER_comm_irecv(smx_simcall_t /*simcall*/, smx_actor_t receiver,
+                                                      smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
                                                       simix_match_func_t match_fun,
                                                       void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data,
                                                       double rate)
@@ -196,7 +201,7 @@ SIMIX_comm_irecv(smx_actor_t dst_proc, smx_mailbox_t mbox, void* dst_buff, size_
       other_comm = std::move(this_synchro);
       mbox->push(other_comm);
     } else {
-      if (other_comm->surf_comm && other_comm->remains() < 1e-12) {
+      if (other_comm->surfAction_ && other_comm->remains() < 1e-12) {
         XBT_DEBUG("comm %p has been already sent, and is finished, destroy it", other_comm.get());
         other_comm->state = SIMIX_DONE;
         other_comm->type = SIMIX_COMM_DONE;
@@ -318,7 +323,7 @@ void simcall_HANDLER_comm_wait(smx_simcall_t simcall, smx_activity_t synchro, do
   } else { /* we need a surf sleep action even when there is no timeout, otherwise surf won't tell us when the host
               fails */
     surf_action_t sleep = simcall->issuer->host->pimpl_cpu->sleep(timeout);
-    sleep->setData(&*synchro);
+    sleep->setData(synchro.get());
 
     simgrid::kernel::activity::CommImplPtr comm =
         boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
@@ -445,7 +450,7 @@ void SIMIX_waitany_remove_simcall_from_actions(smx_simcall_t simcall)
 
 /**
  *  \brief Starts the simulation of a communication synchro.
- *  \param synchro the communication synchro
+ *  \param comm the communication that will be started
  */
 static inline void SIMIX_comm_start(simgrid::kernel::activity::CommImplPtr comm)
 {
@@ -455,15 +460,15 @@ static inline void SIMIX_comm_start(simgrid::kernel::activity::CommImplPtr comm)
     simgrid::s4u::Host* sender   = comm->src_proc->host;
     simgrid::s4u::Host* receiver = comm->dst_proc->host;
 
-    comm->surf_comm = surf_network_model->communicate(sender, receiver, comm->task_size, comm->rate);
-    comm->surf_comm->setData(comm.get());
+    comm->surfAction_ = surf_network_model->communicate(sender, receiver, comm->task_size, comm->rate);
+    comm->surfAction_->setData(comm.get());
     comm->state = SIMIX_RUNNING;
 
     XBT_DEBUG("Starting communication %p from '%s' to '%s' (surf_action: %p)", comm.get(), sender->getCname(),
-              receiver->getCname(), comm->surf_comm);
+              receiver->getCname(), comm->surfAction_);
 
     /* If a link is failed, detect it immediately */
-    if (comm->surf_comm->getState() == simgrid::surf::Action::State::failed) {
+    if (comm->surfAction_->getState() == simgrid::surf::Action::State::failed) {
       XBT_DEBUG("Communication from '%s' to '%s' failed to start because of a link failure", sender->getCname(),
                 receiver->getCname());
       comm->state = SIMIX_LINK_FAILURE;
@@ -482,7 +487,7 @@ static inline void SIMIX_comm_start(simgrid::kernel::activity::CommImplPtr comm)
                   "communication",
                   comm->dst_proc->getCname(), comm->dst_proc->host->getCname());
 
-      comm->surf_comm->suspend();
+      comm->surfAction_->suspend();
     }
   }
 }
@@ -690,7 +695,7 @@ void SIMIX_comm_copy_data(smx_activity_t synchro)
 
   /* Copy at most dst_buff_size bytes of the message to receiver's buffer */
   if (comm->dst_buff_size)
-    buff_size = MIN(buff_size, *(comm->dst_buff_size));
+    buff_size = std::min(buff_size, *(comm->dst_buff_size));
 
   /* Update the receiver's buffer size to the copied amount */
   if (comm->dst_buff_size)