Commit 0694f7d1 authored by Dominik Charousset's avatar Dominik Charousset

Documentation nitpicks

parent 1a8b3841
...@@ -647,8 +647,9 @@ public: ...@@ -647,8 +647,9 @@ public:
return run_scheduled(time_point_cast<duration_t>(when), make_action(what)); return run_scheduled(time_point_cast<duration_t>(when), make_action(what));
} }
/// Runs `what` asynchronously at some point after `when`, iff this actor is /// Runs `what` asynchronously at some point after `when` if the actor still
/// alive. /// exists. The callback is going to hold a weak reference to the actor, i.e.,
/// does not prevent the actor to become unreachable.
/// @param when The local time until the actor waits before invoking the /// @param when The local time until the actor waits before invoking the
/// action. Due to scheduling delays, there will always be some /// action. Due to scheduling delays, there will always be some
/// additional wait time. Passing the current time or a past time /// additional wait time. Passing the current time or a past time
...@@ -685,7 +686,9 @@ public: ...@@ -685,7 +686,9 @@ public:
return run_delayed(duration_cast<timespan>(delay), make_action(what)); return run_delayed(duration_cast<timespan>(delay), make_action(what));
} }
/// Runs `what` asynchronously after the `delay`, iff this actor is alive. /// Runs `what` asynchronously after the `delay` if the actor still exists.
/// The callback is going to hold a weak reference to the actor, i.e., does
/// not prevent the actor to become unreachable.
/// @param delay Minimum amount of time that actor waits before invoking the /// @param delay Minimum amount of time that actor waits before invoking the
/// action. Due to scheduling delays, there will always be some /// action. Due to scheduling delays, there will always be some
/// additional wait time. /// additional wait time.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment