doxygen @ tags replaced to \

This commit is contained in:
2022-03-14 21:19:31 +03:00
parent 9bf1a11701
commit 54b5372356
142 changed files with 1079 additions and 1079 deletions

View File

@@ -24,7 +24,7 @@
#include "piconditionvar.h"
/**
* @brief A Queue that supports operations that wait for the queue to become non-empty when retrieving an element, and
* \brief A Queue that supports operations that wait for the queue to become non-empty when retrieving an element, and
* wait for space to become available in the queue when storing an element.
*/
template <typename T>
@@ -32,7 +32,7 @@ class PIBlockingQueue: private PIQueue<T> {
public:
/**
* @brief Constructor
* \brief Constructor
*/
explicit inline PIBlockingQueue(size_t capacity = SIZE_MAX,
PIConditionVariable* cond_var_add = new PIConditionVariable(),
@@ -40,7 +40,7 @@ public:
: cond_var_add(cond_var_add), cond_var_rem(cond_var_rem), max_size(capacity) { }
/**
* @brief Copy constructor. Initialize queue with copy of other queue elements. Not thread-safe for other queue.
* \brief Copy constructor. Initialize queue with copy of other queue elements. Not thread-safe for other queue.
*/
explicit inline PIBlockingQueue(const PIDeque<T>& other) : cond_var_add(new PIConditionVariable()), cond_var_rem(new PIConditionVariable()) {
mutex.lock();
@@ -50,7 +50,7 @@ public:
}
/**
* @brief Thread-safe copy constructor. Initialize queue with copy of other queue elements.
* \brief Thread-safe copy constructor. Initialize queue with copy of other queue elements.
*/
inline PIBlockingQueue(PIBlockingQueue<T> & other) : cond_var_add(new PIConditionVariable()), cond_var_rem(new PIConditionVariable()) {
other.mutex.lock();
@@ -67,7 +67,7 @@ public:
}
/**
* @brief Inserts the specified element into this queue, waiting if necessary for space to become available.
* \brief Inserts the specified element into this queue, waiting if necessary for space to become available.
*
* @param v the element to add
*/
@@ -83,7 +83,7 @@ public:
PIBlockingQueue<T> & enqueue(const T & v) {return put(v);}
/**
* @brief Inserts the specified element at the end of this queue if it is possible to do so immediately without
* \brief Inserts the specified element at the end of this queue if it is possible to do so immediately without
* exceeding the queue's capacity, returning true upon success and false if this queue is full.
*
* @param v the element to add
@@ -104,7 +104,7 @@ public:
}
/**
* @brief Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.
* \brief Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.
*
* @return the head of this queue
*/
@@ -121,7 +121,7 @@ public:
T dequeue() {return take();}
/**
* @brief Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an
* \brief Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an
* element to become available.
*
* @param timeoutMs how long to wait before giving up, in milliseconds
@@ -146,7 +146,7 @@ public:
}
/**
* @brief Returns the number of elements that this queue can ideally (in the absence of memory or resource
* \brief Returns the number of elements that this queue can ideally (in the absence of memory or resource
* constraints) contains. This is always equal to the initial capacity of this queue less the current size of this queue.
*
* @return the capacity
@@ -160,7 +160,7 @@ public:
}
/**
* @brief Returns the number of additional elements that this queue can ideally (in the absence of memory or resource
* \brief Returns the number of additional elements that this queue can ideally (in the absence of memory or resource
* constraints) accept. This is always equal to the initial capacity of this queue less the current size of this queue.
*
* @return the remaining capacity
@@ -173,7 +173,7 @@ public:
}
/**
* @brief Returns the number of elements in this collection.
* \brief Returns the number of elements in this collection.
*/
size_t size() {
mutex.lock();
@@ -183,7 +183,7 @@ public:
}
/**
* @brief Removes all available elements from this queue and adds them to other given queue.
* \brief Removes all available elements from this queue and adds them to other given queue.
*/
size_t drainTo(PIDeque<T>& other, size_t maxCount = SIZE_MAX) {
mutex.lock();
@@ -194,7 +194,7 @@ public:
}
/**
* @brief Removes all available elements from this queue and adds them to other given queue.
* \brief Removes all available elements from this queue and adds them to other given queue.
*/
size_t drainTo(PIBlockingQueue<T>& other, size_t maxCount = SIZE_MAX) {
mutex.lock();