Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix another bunch of warnings in doc generation.
[simgrid.git] / include / simgrid / s4u / Link.hpp
index 1ab58c8..7473903 100644 (file)
@@ -70,6 +70,10 @@ public:
   /**
    * @brief Set latency (string version)
    *
+   * Accepts values with units, such as '1s' or '7ms'.
+   *
+   * Full list of accepted units: w (week), d (day), h, s, ms, us, ns, ps.
+   *
    * @throw std::invalid_argument if latency format is incorrect.
    */
   Link* set_latency(const std::string& value);
@@ -172,12 +176,12 @@ public:
 
 /**
  * @beginrst
- * Another encapsulation for using links in the :cpp:function:: NetZone::add_route
+ * Another encapsulation for using links in the :cpp:func:`NetZone::add_route`
  *
  * When adding a route with split-duplex links, you need to specify the direction of the link
  * so SimGrid can know exactly which physical link to insert in the route.
  *
- * For shared/fat-pipe links, use the Direction::NONE since they don't have
+ * For shared/fat-pipe links, use the :cpp:enumerator:`Direction::NONE` since they don't have
  * the concept of UP/DOWN links.
  * @endrst
  */
@@ -185,7 +189,7 @@ class XBT_PUBLIC LinkInRoute {
 public:
   enum class Direction { UP = 2, DOWN = 1, NONE = 0 };
 
-  LinkInRoute(const Link* link) : link_(link) {}
+  explicit LinkInRoute(const Link* link) : link_(link) {}
   LinkInRoute(const Link* link, Direction d) : link_(link), direction_(d) {}
 
   /** @brief Get direction of this link in the route: UP or DOWN */