Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fix some doxygen warnings
authorMartin Quinson <martin.quinson@loria.fr>
Sat, 23 Dec 2017 09:45:21 +0000 (10:45 +0100)
committerMartin Quinson <martin.quinson@loria.fr>
Sat, 23 Dec 2017 09:45:21 +0000 (10:45 +0100)
src/kernel/lmm/maxmin.cpp
src/kernel/lmm/maxmin.hpp
src/simix/smx_network.cpp

index 6380a5a..633dc21 100644 (file)
@@ -955,8 +955,6 @@ void System::remove_all_modified_set()
  *
  * If the resource is not shared (ie in FATPIPE mode), then the load is the max (not the sum) of all resource usages
  * located on this resource.
- *
- * \param cnst the lmm_constraint_t associated to the resource
  */
 double Constraint::get_usage() const
 {
index 608d6f4..f302f2f 100644 (file)
@@ -230,7 +230,7 @@ public:
 
   /**
    * @brief Sets the concurrency limit for this constraint
-   * @param concurrency_limit The concurrency limit to use for this constraint
+   * @param limit The concurrency limit to use for this constraint
    */
   void set_concurrency_limit(int limit)
   {
@@ -353,7 +353,7 @@ public:
 
   /**
    * @brief Set the concurrent share of the variable
-   * @param concurrency_share The new concurrency share
+   * @param value The new concurrency share
    */
   void set_concurrency_share(short int value) { concurrency_share = value; }
 
index b455657..ea92bfd 100644 (file)
@@ -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
@@ -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)
 {