Skip to content

Enhanced Doxygen #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cliffg-softwarelibre merged 1 commit into from
Sep 9, 2024
Merged

Enhanced Doxygen #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions include/queue/wait_queue.hpp
View file
Open in desktop
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