Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[no-ci] indicate which methods and signals are static in the doc
[simgrid.git] / include / simgrid / s4u / Link.hpp
index 816e62a..3e0832b 100644 (file)
@@ -49,7 +49,7 @@ public:
 
   kernel::resource::StandardLinkImpl* get_impl() const;
 
-  /** @brief Retrieve a link from its name */
+  /** \static @brief Retrieve a link from its name */
   static Link* by_name(const std::string& name);
   static Link* by_name_or_null(const std::string& name);
 
@@ -169,9 +169,9 @@ private:
 
 public:
   /* The signals */
-  /** @brief Add a callback fired when a new Link is created */
+  /** \static @brief Add a callback fired when a new Link is created */
   static void on_creation_cb(const std::function<void(Link&)>& cb) { on_creation.connect(cb); }
-  /** @brief Add a callback fired when any Link is turned on or off */
+  /** \static @brief Add a callback fired when any Link is turned on or off */
   static void on_onoff_cb(const std::function<void(Link const&)>& cb)
   {
     on_onoff.connect(cb);
@@ -181,20 +181,20 @@ public:
   {
     on_this_onoff.connect(cb);
   }
-  /** @brief Add a callback fired when the bandwidth of any Link changes */
+  /** \static @brief Add a callback fired when the bandwidth of any Link changes */
   static void on_bandwidth_change_cb(const std::function<void(Link const&)>& cb) { on_bandwidth_change.connect(cb); }
   /** @brief Add a callback fired when the bandwidth of this specific Link changes */
   void on_this_bandwidth_change_cb(const std::function<void(Link const&)>& cb)
   {
     on_this_bandwidth_change.connect(cb);
   }
-  /** @brief Add a callback fired when a communication changes it state (ready/done/cancel) */
+  /** \static @brief Add a callback fired when a communication changes it state (ready/done/cancel) */
   static void on_communication_state_change_cb(
       const std::function<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>& cb)
   {
     on_communication_state_change.connect(cb);
   }
-  /** @brief Add a callback fired when any Link is destroyed */
+  /** \static @brief Add a callback fired when any Link is destroyed */
   static void on_destruction_cb(const std::function<void(Link const&)>& cb) { on_destruction.connect(cb); }
   /** @brief Add a callback fired when this specific Link is destroyed */
   void on_this_destruction_cb(const std::function<void(Link const&)>& cb)
@@ -224,7 +224,7 @@ public:
   /** @brief Get the link direction down */
   Link* get_link_down() const;
 
-  /** @brief Retrieve a link from its name */
+  /** \static @brief Retrieve a link from its name */
   static SplitDuplexLink* by_name(const std::string& name);
 };