Skip to content

Commit

Permalink
Fix #1803 with documentation refactoring
Browse files Browse the repository at this point in the history
  • Loading branch information
Syntaf committed Nov 16, 2015
1 parent 884a57f commit 837ca3d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
8 changes: 4 additions & 4 deletions hpx/lcos/wait_all.hpp
Expand Up @@ -14,7 +14,7 @@ namespace hpx
{
/// The function \a wait_all is a operator allowing to join on the result
/// of all given futures. It AND-composes all future objects given and
/// returns the same list of futures after they finished executing.
/// returns after they finished executing.
///
/// \param first The iterator pointing to the first element of a
/// sequence of \a future or \a shared_future objects for
Expand All @@ -32,7 +32,7 @@ namespace hpx

/// The function \a wait_all is a operator allowing to join on the result
/// of all given futures. It AND-composes all future objects given and
/// returns the same list of futures after they finished executing.
/// returns after they finished executing.
///
/// \param futures A vector holding an arbitrary amount of \a future or
/// \a shared_future objects for which \a wait_all should
Expand All @@ -47,7 +47,7 @@ namespace hpx

/// The function \a wait_all is a operator allowing to join on the result
/// of all given futures. It AND-composes all future objects given and
/// returns the same list of futures after they finished executing.
/// returns after they finished executing.
///
/// \param futures An arbitrary number of \a future or \a shared_future
/// objects, possibly holding different types for which
Expand All @@ -62,7 +62,7 @@ namespace hpx

/// The function \a wait_all_n is a operator allowing to join on the result
/// of all given futures. It AND-composes all future objects given and
/// returns the same list of futures after they finished executing.
/// returns after they finished executing.
///
/// \param begin The iterator pointing to the first element of a
/// sequence of \a future or \a shared_future objects for
Expand Down
20 changes: 10 additions & 10 deletions hpx/lcos/wait_any.hpp
Expand Up @@ -13,8 +13,8 @@
namespace hpx
{
/// The function \a wait_any is a non-deterministic choice operator. It
/// OR-composes all future objects given and returns the same list of
/// futures after one future of that list finishes execution.
/// OR-composes all future objects given and returns after one future of
/// that list finishes execution.
///
/// \param first [in] The iterator pointing to the first element of a
/// sequence of \a future or \a shared_future objects for
Expand All @@ -40,8 +40,8 @@ namespace hpx
void wait_any(InputIter first, InputIter last, error_code& ec = throws);

/// The function \a wait_any is a non-deterministic choice operator. It
/// OR-composes all future objects given and returns the same list of
/// futures after one future of that list finishes execution.
/// OR-composes all future objects given and returns after one future of
/// that list finishes execution.
///
/// \param futures [in] A vector holding an arbitrary amount of \a future or
/// \a shared_future objects for which \a wait_any should
Expand All @@ -64,8 +64,8 @@ namespace hpx
void wait_any(std::vector<future<R>>& futures, error_code& ec = throws);

/// The function \a wait_any is a non-deterministic choice operator. It
/// OR-composes all future objects given and returns the same list of
/// futures after one future of that list finishes execution.
/// OR-composes all future objects given and returns after one future of
/// that list finishes execution.
///
/// \param futures [in] An arbitrary number of \a future or \a shared_future
/// objects, possibly holding different types for which
Expand All @@ -88,8 +88,8 @@ namespace hpx
void wait_any(error_code& ec, T&&... futures);

/// The function \a wait_any is a non-deterministic choice operator. It
/// OR-composes all future objects given and returns the same list of
/// futures after one future of that list finishes execution.
/// OR-composes all future objects given and returns after one future of
/// that list finishes execution.
///
/// \param futures [in] An arbitrary number of \a future or \a shared_future
/// objects, possibly holding different types for which
Expand All @@ -104,8 +104,8 @@ namespace hpx
void wait_any(T&&... futures);

/// The function \a wait_any_n is a non-deterministic choice operator. It
/// OR-composes all future objects given and returns the same list of
/// futures after one future of that list finishes execution.
/// OR-composes all future objects given and returns after one future of
/// that list finishes execution.
///
/// \param first [in] The iterator pointing to the first element of a
/// sequence of \a future or \a shared_future objects for
Expand Down

0 comments on commit 837ca3d

Please sign in to comment.