New signal: Engine::on_simulation_start

[simgrid.git] / include / simgrid / s4u / Link.hpp

diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp
index 5939fe3..acb4092 100644 (file)
--- a/include/simgrid/s4u/Link.hpp
+++ b/include/simgrid/s4u/Link.hpp
@@ -122,7 +122,10 @@ public:
    * current function to specify that a given host uses another level of bandwidth. This can be used to take the
    * location of hosts into account, or even to model mobility in your SimGrid simulation.
    *
-   * Note that this function asserts that the link is actually a wifi link */
+   * Note that this function asserts that the link is actually a wifi link
+   *
+   * warning: in the case where a 0Mbps data rate should be used, set that rate only once during the
+   * experiment, and don't modify the bandwidth of that host later */
   void set_host_wifi_rate(const s4u::Host* host, int level) const;
 
   /** @brief Returns the current load (in bytes per second) */
@@ -134,8 +137,11 @@ public:
   /** @brief Check if the Link is shared (not a FATPIPE) */
   bool is_shared() const;
 
+  /** Turns the link on. */
   void turn_on();
+  /** Turns the link off. */
   void turn_off();
+  /** Checks whether the link is on. */
   bool is_on() const;
 
   Link* seal();