Skip to content

Commit

Permalink
Fix comment language
Browse files Browse the repository at this point in the history
  • Loading branch information
codemercenary committed May 23, 2016
1 parent f0929e3 commit c9988a0
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions src/autowiring/DispatchQueue.h
Expand Up @@ -248,18 +248,23 @@ class DispatchQueue {
/// Blocks until all dispatchers on the DispatchQueue at the time of the call have been dispatched
/// </summary>
/// <param name="timeout">
/// The maximum amount of time to wait. If this value is zero, this method will not obtain any locks.
/// The maximum amount of time to wait. If this value is zero, this method will not wait.
/// </param>
/// <remarks>
/// This method does not cause any dispatchers to run. If the underlying dispatch queue does not have an event loop
/// operating on it, this method will deadlock. It is an error for the party responsible for driving the dispatch queue
/// via WaitForEvent or DispatchAllEvents unless that party first delegates the responsibility elsewhere.
/// via WaitForEvent or DispatchAllEvents to call this method unless that party first delegates the responsibility
/// elsewhere.
///
/// If DispatchQueue::Abort() is called before the dispatcher has been completed, this method will throw an exception.
/// If a dispatcher on the underlying DispatchQueue throws an exception, this method will also throw an exception.
///
/// If zero is passed as the timeout value, this method will return true if and only if the queue was empty at the time
/// of the call, ignoring any delayed dispatchers.
///
/// If timeout is nonzero, this method will pend a dispatcher to the queue and only return true if this dispatcher
/// is actually dispatched. If the timeout is zero, this method will return true immediately if the queue length
/// is exactly zero.
/// </remarks>
bool Barrier(std::chrono::nanoseconds timeout);

Expand Down

0 comments on commit c9988a0

Please sign in to comment.