Skip to content

Commit

Permalink
Enhanced Doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
cliffg-softwarelibre committed Sep 9, 2024
1 parent 6fdba5f commit 14fdc14
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions include/queue/wait_queue.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -191,8 +191,20 @@ concept supports_size = requires (Ctr ctr) {
ctr.size();
};

// declaration for wait_queue

/**
* @brief MPMC thread-safe wait queue with shutdown semantics.
*
* @tparam T Type of value that will be passed through the queue.
*
* @tparam Container that is used as the underlying data queue.
*
* @pre The value type must be either copy constructible or move constructible. It does not
* have to be both, and in particular a default constructor is not required.
*
* @pre The container type must support certain operations depending on which ones are called.
* The constraints are specified on each particular operation.
*
*/
template <typename T, typename Container = std::deque<T> >
requires std::is_copy_constructible_v<T> || std::is_move_constructible_v<T>
class wait_queue {
Expand Down

0 comments on commit 14fdc14

Please sign in to comment.