diff options
Diffstat (limited to 'src/doc/src/qcircularbuffer.qdoc')
| -rw-r--r-- | src/doc/src/qcircularbuffer.qdoc | 318 |
1 files changed, 159 insertions, 159 deletions
diff --git a/src/doc/src/qcircularbuffer.qdoc b/src/doc/src/qcircularbuffer.qdoc index 41cee96de..e313a7375 100644 --- a/src/doc/src/qcircularbuffer.qdoc +++ b/src/doc/src/qcircularbuffer.qdoc @@ -37,7 +37,7 @@ ** ****************************************************************************/ -/*! +/* !\internal \class Qt3DCore::QCircularBuffer \inmodule Qt3DCore \brief A template class providing a dynamic circular array. @@ -198,14 +198,14 @@ \sa iterator, const_iterator, QVector, QList, QLinkedList */ -/*! \fn Qt3DCore::QCircularBuffer::QCircularBuffer() +/* \fn Qt3DCore::QCircularBuffer::QCircularBuffer() Constructs an empty circular buffer with zero capacity. \sa resize(), setCapacity() */ -/*! \fn Qt3DCore::QCircularBuffer::QCircularBuffer(int capacity) +/* \fn Qt3DCore::QCircularBuffer::QCircularBuffer(int capacity) Constructs an empty circular buffer with an initial capacity of \a capacity elements. @@ -213,7 +213,7 @@ \sa resize(), setCapacity() */ -/*! \fn Qt3DCore::QCircularBuffer::QCircularBuffer(int capacity, const T &value) +/* \fn Qt3DCore::QCircularBuffer::QCircularBuffer(int capacity, const T &value) Constructs a circular buffer with an initial capacity and size of \a capacity elements. @@ -223,7 +223,7 @@ \sa resize(), setCapacity(), fill() */ -/*! \fn Qt3DCore::QCircularBuffer::QCircularBuffer(int capacity, int size, const T &value) +/* \fn Qt3DCore::QCircularBuffer::QCircularBuffer(int capacity, int size, const T &value) Constructs a circular buffer with an initial capacity of \a capacity elements and initial size of \a size elements. @@ -233,7 +233,7 @@ \sa resize(), setCapacity(), fill() */ -/*! \fn Qt3DCore::QCircularBuffer::QCircularBuffer(const QCircularBuffer<T> &other) +/* \fn Qt3DCore::QCircularBuffer::QCircularBuffer(const QCircularBuffer<T> &other) Constructs a copy of \a other. @@ -245,18 +245,18 @@ \sa operator=() */ -/*! \fn Qt3DCore::QCircularBuffer::~QCircularBuffer() +/* \fn Qt3DCore::QCircularBuffer::~QCircularBuffer() Destroys the circular buffer. */ -/*! \fn QCircularBuffer &Qt3DCore::QCircularBuffer::operator=(const QCircularBuffer<T> &other) +/* \fn QCircularBuffer &Qt3DCore::QCircularBuffer::operator=(const QCircularBuffer<T> &other) Assigns \a other to this circular buffer and returns a reference to this circular buffer. */ -/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::begin() +/* \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::begin() Returns an \l{STL-Style iterators}{STL-style iterator} pointing to the first item in the circular buffer. @@ -264,12 +264,12 @@ \sa constBegin(), end() */ -/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::begin() const +/* \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::begin() const \overload */ -/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::constBegin() const +/* \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::constBegin() const Returns a const \l{STL-Style Iterators}{STL-style iterator} pointing to the first item in the circular buffer. @@ -277,7 +277,7 @@ \sa begin(), constEnd() */ -/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::end() +/* \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::end() Returns an \l {STL-Style Iterators} {STL-style iterator} pointing to the imaginary item after the last item in the circular buffer. @@ -285,12 +285,12 @@ \sa begin(), constEnd() */ -/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::end() const +/* \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::end() const \overload */ -/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::constEnd() const +/* \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::constEnd() const Returns a const \l{STL-Style Iterators} {STL-style iterator} pointing to the imaginary item after the last item in the circular buffer. @@ -298,7 +298,7 @@ \sa constBegin(), end() */ -/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::erase(const_iterator pos) +/* \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::erase(const_iterator pos) Removes the item pointed to by the iterator \a pos from the circular buffer, and returns an iterator to the next item in the circular @@ -307,7 +307,7 @@ \sa insert(), remove() */ -/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::erase(const_iterator begin, const_iterator end) +/* \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::erase(const_iterator begin, const_iterator end) \overload @@ -316,65 +316,65 @@ before the call. */ -/*! \fn void Qt3DCore::QCircularBuffer::push_back(const T &value) +/* \fn void Qt3DCore::QCircularBuffer::push_back(const T &value) This function is provided for STL compatibility. It is equivalent to append(\a value). */ -/*! \fn void Qt3DCore::QCircularBuffer::push_front(const T &value) +/* \fn void Qt3DCore::QCircularBuffer::push_front(const T &value) This function is provided for STL compatibility. It is equivalent to prepend(\a value). */ -/*! \fn void Qt3DCore::QCircularBuffer::pop_back() +/* \fn void Qt3DCore::QCircularBuffer::pop_back() This function is provided for STL compatibility. It is equivalent to erase(end() - 1). */ -/*! \fn void Qt3DCore::QCircularBuffer::pop_front() +/* \fn void Qt3DCore::QCircularBuffer::pop_front() This function is provided for STL compatibility. It is equivalent to erase(begin()). */ -/*! \fn bool Qt3DCore::QCircularBuffer::empty() const +/* \fn bool Qt3DCore::QCircularBuffer::empty() const This function is provided for STL compatibility. It is equivalent to isEmpty(), returning true if the circular buffer is empty; otherwise returns false. */ -/*! \fn Qt3DCore::QCircularBuffer::reference Qt3DCore::QCircularBuffer::front() +/* \fn Qt3DCore::QCircularBuffer::reference Qt3DCore::QCircularBuffer::front() This function is provided for STL compatibility. It is equivalent to first(). */ -/*! \fn Qt3DCore::QCircularBuffer::const_reference Qt3DCore::QCircularBuffer::front() const +/* \fn Qt3DCore::QCircularBuffer::const_reference Qt3DCore::QCircularBuffer::front() const \overload */ -/*! \fn Qt3DCore::QCircularBuffer::reference Qt3DCore::QCircularBuffer::back() +/* \fn Qt3DCore::QCircularBuffer::reference Qt3DCore::QCircularBuffer::back() This function is provided for STL compatibility. It is equivalent to last(). */ -/*! \fn Qt3DCore::QCircularBuffer::const_reference Qt3DCore::QCircularBuffer::back() const +/* \fn Qt3DCore::QCircularBuffer::const_reference Qt3DCore::QCircularBuffer::back() const \overload */ -/*! \fn int Qt3DCore::QCircularBuffer::refCount() const +/* \fn int Qt3DCore::QCircularBuffer::refCount() const Returns the number of shallow copies that exist of this circular buffer. */ -/*! \fn Qt3DCore::QCircularBuffer::append(const T &value) +/* \fn Qt3DCore::QCircularBuffer::append(const T &value) Inserts \a value at the end of the circular buffer. If the circular buffer is full, then the oldest element is overwritten. @@ -388,7 +388,7 @@ \sa operator<<(), operator+=(), prepend(), insert() */ -/*! \fn const T &Qt3DCore::QCircularBuffer::at(int i) const +/* \fn const T &Qt3DCore::QCircularBuffer::at(int i) const Returns the item at index position \a i in the circular buffer. @@ -398,7 +398,7 @@ \sa value(), operator[]() */ -/*! \fn T &Qt3DCore::QCircularBuffer::operator[](int i) +/* \fn T &Qt3DCore::QCircularBuffer::operator[](int i) Returns the item at index position \a i as a modifiable reference. @@ -411,14 +411,14 @@ \sa at(), value() */ -/*! \fn const T &Qt3DCore::QCircularBuffer::operator[](int i) const +/* \fn const T &Qt3DCore::QCircularBuffer::operator[](int i) const \overload Same as at(\a i). */ -/*! \fn int Qt3DCore::QCircularBuffer::capacity() const +/* \fn int Qt3DCore::QCircularBuffer::capacity() const Returns the maximum number of elements that can be stored in the circular buffer. @@ -426,7 +426,7 @@ \sa setCapacity(), size() */ -/*! \fn void Qt3DCore::QCircularBuffer::clear() +/* \fn void Qt3DCore::QCircularBuffer::clear() Removes all elements from the circular buffer so that the size is zero. The capacity is unchanged. @@ -434,7 +434,7 @@ \sa isEmpty() */ -/*! \fn bool Qt3DCore::QCircularBuffer::contains(const T &value) const +/* \fn bool Qt3DCore::QCircularBuffer::contains(const T &value) const Returns true if the circular buffer contains an occurrence of \a value; otherwise returns false. @@ -445,7 +445,7 @@ \sa indexOf(), count() */ -/*! \fn int Qt3DCore::QCircularBuffer::count(const T &value) const +/* \fn int Qt3DCore::QCircularBuffer::count(const T &value) const Returns the number of occurrences of \a value in the circular buffer. @@ -455,14 +455,14 @@ \sa contains(), indexOf() */ -/*! \fn int Qt3DCore::QCircularBuffer::count() const +/* \fn int Qt3DCore::QCircularBuffer::count() const \overload Same as size(). */ -/*! \fn Qt3DCore::QCircularBuffer::array_range Qt3DCore::QCircularBuffer::data() +/* \fn Qt3DCore::QCircularBuffer::array_range Qt3DCore::QCircularBuffer::data() Returns an \l array_range describing the internal array of data. If the circular buffer is non-linearized, then this function causes it to be @@ -475,7 +475,7 @@ \sa constData(), dataOne(), dataTwo(), isLinearised() */ -/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::data() const +/* \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::data() const \overload @@ -484,7 +484,7 @@ constness. */ -/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::constData() const +/* \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::constData() const Returns a \l const_array_range describing the internal array of data. @@ -499,7 +499,7 @@ \sa data(), constDataOne(), constDataTwo(), isLinearised() */ -/*! \fn Qt3DCore::QCircularBuffer::array_range Qt3DCore::QCircularBuffer::dataOne() +/* \fn Qt3DCore::QCircularBuffer::array_range Qt3DCore::QCircularBuffer::dataOne() Returns an \l array_range describing the first internal array of contiguous data. If the circular buffer is linearized, then this function is @@ -515,7 +515,7 @@ \sa constDataOne(), dataTwo(), data(), isLinearised() */ -/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::dataOne() const +/* \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::dataOne() const \overload @@ -523,7 +523,7 @@ (unless the circular buffer is empty). */ -/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::constDataOne() const +/* \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::constDataOne() const Returns a \l const_array_range describing the first internal array of contiguous data. If the circular buffer is linearized, then this function is @@ -539,7 +539,7 @@ \sa dataOne(), constDataTwo(), constData(), isLinearised() */ -/*! \fn Qt3DCore::QCircularBuffer::array_range Qt3DCore::QCircularBuffer::dataTwo() +/* \fn Qt3DCore::QCircularBuffer::array_range Qt3DCore::QCircularBuffer::dataTwo() Returns an \l array_range describing the first internal array of contiguous data. If the circular buffer is linearized, then the pointer and array size @@ -549,12 +549,12 @@ \sa dataOne(), constDataTwo(), data(), isLinearised() */ -/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::dataTwo() const +/* \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::dataTwo() const \overload */ -/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::constDataTwo() const +/* \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::constDataTwo() const Returns a \l const_array_range describing the first internal array of contiguous data. If the circular buffer is linearized, then the pointer and array size @@ -564,7 +564,7 @@ \sa constDataOne(), dataTwo(), constData(), isLinearised() */ -/*! \fn bool Qt3DCore::QCircularBuffer::endsWith(const T &value) const +/* \fn bool Qt3DCore::QCircularBuffer::endsWith(const T &value) const Returns \c true if this circular buffer is not empty and its last item is equal to \a value; otherwise returns \c false. @@ -572,7 +572,7 @@ \sa isEmpty(), last(), startsWith() */ -/*! \fn QCircularBuffer<T>& Qt3DCore::QCircularBuffer::fill(const T &value, int size = -1) +/* \fn QCircularBuffer<T>& Qt3DCore::QCircularBuffer::fill(const T &value, int size = -1) Assigns \a value to all items in the circular buffer. If \a size is different from -1 (the default), the circular buffer is resized to size \a @@ -586,7 +586,7 @@ \sa resize() */ -/*! \fn T &Qt3DCore::QCircularBuffer::first() +/* \fn T &Qt3DCore::QCircularBuffer::first() Returns a reference to the first item in the circular buffer. This function assumes that the circular buffer isn't empty. @@ -594,12 +594,12 @@ \sa last(), isEmpty() */ -/*! \fn const T &Qt3DCore::QCircularBuffer::first() const +/* \fn const T &Qt3DCore::QCircularBuffer::first() const \overload */ -/*! \fn int Qt3DCore::QCircularBuffer::freeSize() const +/* \fn int Qt3DCore::QCircularBuffer::freeSize() const Returns the number of items that can be added to the circular buffer without causing the earliest item to be overwritten. It is equivalent @@ -608,7 +608,7 @@ \sa sizeAvailable(), capacity(), isEmpty(), isFull(), size() */ -/*! \fn static QCircularBuffer<T> Qt3DCore::QCircularBuffer::fromList(const QList<T>& list) +/* \fn static QCircularBuffer<T> Qt3DCore::QCircularBuffer::fromList(const QList<T>& list) Returns a QCircularBuffer object with the data contained in \a list. The capacity and size of the circular buffer will be equal to the size of @@ -620,7 +620,7 @@ \sa fromVector(), toList(), toVector() */ -/*! \fn static QCircularBuffer<T> Qt3DCore::QCircularBuffer::fromVector(const QVector<T>& vector) +/* \fn static QCircularBuffer<T> Qt3DCore::QCircularBuffer::fromVector(const QVector<T>& vector) Returns a QCircularBuffer object with the data contained in \a vector. The capacity and size of the circular buffer will be equal to the size of @@ -629,7 +629,7 @@ \sa fromList(), toVector(), toList() */ -/*! \fn int Qt3DCore::QCircularBuffer::indexOf(const T &value, int from = 0) const +/* \fn int Qt3DCore::QCircularBuffer::indexOf(const T &value, int from = 0) const Returns the index position of the first occurrence of \a value in the circular buffer, searching forward from index position \a from. @@ -644,7 +644,7 @@ \sa lastIndexOf(), contains() */ -/*! \fn void Qt3DCore::QCircularBuffer::insert(int i, const T &value) +/* \fn void Qt3DCore::QCircularBuffer::insert(int i, const T &value) Inserts \a value at index position \a i in the circular buffer. If \a i is 0, the value is prepended to the circular buffer. If \a i @@ -676,7 +676,7 @@ \sa append(), prepend(), remove() */ -/*! \fn void Qt3DCore::QCircularBuffer::insert(int i, int count, const T &value) +/* \fn void Qt3DCore::QCircularBuffer::insert(int i, int count, const T &value) \overload @@ -710,7 +710,7 @@ \sa append(), prepend(), remove() */ -/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::insert(const_iterator before, int count, const T &value) +/* \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::insert(const_iterator before, int count, const T &value) \overload @@ -721,7 +721,7 @@ \sa append(), prepend(), remove() */ -/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::insert(const_iterator before, const T &value) +/* \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::insert(const_iterator before, const T &value) \overload @@ -731,21 +731,21 @@ \sa append(), prepend(), remove() */ -/*! \fn bool Qt3DCore::QCircularBuffer::isEmpty() const +/* \fn bool Qt3DCore::QCircularBuffer::isEmpty() const Returns true if the circular buffer has size 0; otherwise returns false. \sa capacity(), resize(), setCapacity(), size() */ -/*! \fn bool Qt3DCore::QCircularBuffer::isFull() const +/* \fn bool Qt3DCore::QCircularBuffer::isFull() const Returns true if the circular buffer is full ie if size() == capacity(); otherwise returns false. \sa capacity(), resize(), setCapacity(), size() */ -/*! \fn bool Qt3DCore::QCircularBuffer::isLinearised() const +/* \fn bool Qt3DCore::QCircularBuffer::isLinearised() const Returns \c true if the circular buffer is linearized; otherwise returns \c false. @@ -820,7 +820,7 @@ \sa linearise(), data(), dataOne(), dataTwo() */ -/*! \fn T &Qt3DCore::QCircularBuffer::last() +/* \fn T &Qt3DCore::QCircularBuffer::last() Returns a reference to the last item in the circular buffer. This function assumes that the circular buffer isn't empty. @@ -828,12 +828,12 @@ \sa first(), isEmpty() */ -/*! \fn const T &Qt3DCore::QCircularBuffer::last() const +/* \fn const T &Qt3DCore::QCircularBuffer::last() const \overload */ -/*! \fn int Qt3DCore::QCircularBuffer::lastIndexOf(const T &value, int from = -1) const +/* \fn int Qt3DCore::QCircularBuffer::lastIndexOf(const T &value, int from = -1) const Returns the index position of the last occurrence of the value \a value in the circular buffer, searching backward from index position \a @@ -849,7 +849,7 @@ \sa indexOf() */ -/*! \fn void Qt3DCore::QCircularBuffer::linearise() +/* \fn void Qt3DCore::QCircularBuffer::linearise() Linearizes the internal representation of the circular buffer such that all items are stored in a single contiguous array. @@ -859,7 +859,7 @@ \sa isLinearised() */ -/*! \fn void Qt3DCore::QCircularBuffer::prepend(const T &value) +/* \fn void Qt3DCore::QCircularBuffer::prepend(const T &value) Inserts \a value at the beginning of the circular buffer. If the circular buffer is full, then the highest index item is overwritten. @@ -873,14 +873,14 @@ \sa operator<<(), operator+=(), append(), insert() */ -/*! \fn void Qt3DCore::QCircularBuffer::remove(int i) +/* \fn void Qt3DCore::QCircularBuffer::remove(int i) Removes the element at index position \a i. \sa insert(), replace(), fill() */ -/*! \fn void Qt3DCore::QCircularBuffer::remove(int i, int count) +/* \fn void Qt3DCore::QCircularBuffer::remove(int i, int count) \overload @@ -890,7 +890,7 @@ \sa insert(), replace(), fill() */ -/*! \fn void Qt3DCore::QCircularBuffer::replace(int i, const T &value) +/* \fn void Qt3DCore::QCircularBuffer::replace(int i, const T &value) Replaces the item at index position \a i with \a value. @@ -900,7 +900,7 @@ \sa operator[](), remove() */ -/*! \fn void Qt3DCore::QCircularBuffer::reserve(int capacity) +/* \fn void Qt3DCore::QCircularBuffer::reserve(int capacity) Sets the capacity of the circular buffer to \a capacity. It is a synonym for setCapacity(). @@ -908,7 +908,7 @@ \sa setCapacity() */ -/*! \fn void Qt3DCore::QCircularBuffer::resize(int size) +/* \fn void Qt3DCore::QCircularBuffer::resize(int size) Changes the size of the circular buffer to \a size which must be > 0 and <= capacity(). If \a size is less than the old size, then the highest indexed @@ -919,21 +919,21 @@ \sa size(), insert(), remove(), capacity(), setCapacity() */ -/*! \fn void Qt3DCore::QCircularBuffer::setCapacity(int capacity) +/* \fn void Qt3DCore::QCircularBuffer::setCapacity(int capacity) Sets the capacity of the circular buffer to \a capacity. \sa reserve(), capacity() */ -/*! \fn int Qt3DCore::QCircularBuffer::size() const +/* \fn int Qt3DCore::QCircularBuffer::size() const Returns the number of items in the circular buffer. \sa sizeAvailable(), capacity(), resize() */ -/*! \fn int Qt3DCore::QCircularBuffer::sizeAvailable() const +/* \fn int Qt3DCore::QCircularBuffer::sizeAvailable() const Returns the number of items that can be added to the circular buffer without causing the earliest item to be overwritten. It is equivalent @@ -942,7 +942,7 @@ \sa capacity(), isEmpty(), isFull(), size(), freeSize() */ -/*! \fn void Qt3DCore::QCircularBuffer::squeeze() +/* \fn void Qt3DCore::QCircularBuffer::squeeze() Releases any unused memory from the circular buffer. It is equivalent to calling setCapacity(size()). @@ -950,7 +950,7 @@ \sa setCapacity(), size(), resize(), sizeAvailable() */ -/*! \fn bool Qt3DCore::QCircularBuffer::startsWith(const T &value) const +/* \fn bool Qt3DCore::QCircularBuffer::startsWith(const T &value) const Returns \c true if the circular buffer is not empty and its first item is equal to \a value; otherwise returns \c false. @@ -958,7 +958,7 @@ \sa isEmpty(), first(), endsWith() */ -/*! \fn QList<T> Qt3DCore::QCircularBuffer::toList() const +/* \fn QList<T> Qt3DCore::QCircularBuffer::toList() const Returns a QList object with the data contained in this QCircularBuffer. @@ -969,14 +969,14 @@ \sa fromList(), toVector() */ -/*! \fn QVector<T> Qt3DCore::QCircularBuffer::toVector() const +/* \fn QVector<T> Qt3DCore::QCircularBuffer::toVector() const Returns a QVector object with the data contained in this QCircularBuffer. \sa fromVector(), toList() */ -/*! \fn T Qt3DCore::QCircularBuffer::value(int i) const +/* \fn T Qt3DCore::QCircularBuffer::value(int i) const Returns the value at index position \a i in the circular buffer. @@ -988,7 +988,7 @@ \sa at(), operator[]() */ -/*! \fn T Qt3DCore::QCircularBuffer::value(int i, const T &defaultValue) const +/* \fn T Qt3DCore::QCircularBuffer::value(int i, const T &defaultValue) const \overload @@ -996,7 +996,7 @@ \a defaultValue. */ -/*! \fn bool Qt3DCore::operator==(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) +/* \fn bool Qt3DCore::operator==(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) Returns \c true if the circular buffer \a lhs is equal to \a rhs; otherwise returns \c false. @@ -1010,7 +1010,7 @@ \sa operator!=() */ -/*! \fn bool Qt3DCore::operator!=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) +/* \fn bool Qt3DCore::operator!=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) Returns \c true if the circular buffer \a lhs is not equal to \a rhs; otherwise returns \c false. @@ -1024,7 +1024,7 @@ \sa operator==() */ -/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator+=(const T &other) +/* \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator+=(const T &other) Appends the item \a other to this circular buffer and returns a reference to this circular buffer. @@ -1032,7 +1032,7 @@ \sa operator+(), operator<<(), append() */ -/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator+=(const QCircularBuffer<T>& other) +/* \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator+=(const QCircularBuffer<T>& other) \overload @@ -1042,17 +1042,17 @@ \sa operator+(), operator<<(), append() */ -/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator+=(const QVector<T>& other) +/* \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator+=(const QVector<T>& other) \overload */ -/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator+=(const QList<T>& other) +/* \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator+=(const QList<T>& other) \overload */ -/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator<<(const T &other) +/* \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator<<(const T &other) Appends the item \a other to this circular buffer and returns a reference to this circular buffer. @@ -1060,7 +1060,7 @@ \sa operator+(), operator+=(), append() */ -/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator<<(const QCircularBuffer<T>& other) +/* \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator<<(const QCircularBuffer<T>& other) \overload @@ -1070,17 +1070,17 @@ \sa operator+(), operator+=(), append() */ -/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator<<(const QVector<T>& other) +/* \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator<<(const QVector<T>& other) \overload */ -/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator<<(const QList<T>& other) +/* \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator<<(const QList<T>& other) \overload */ -/*! \fn Qt3DCore::QCircularBuffer<T> Qt3DCore::operator+(const QCircularBuffer<T>& lhs, const QCircularBuffer<T>& rhs) +/* \fn Qt3DCore::QCircularBuffer<T> Qt3DCore::operator+(const QCircularBuffer<T>& lhs, const QCircularBuffer<T>& rhs) \relates Qt3DCore::QCircularBuffer Returns a circular buffer object with capacity of lhs.size() + rhs.size() containing @@ -1089,78 +1089,78 @@ \sa {QCircularBuffer::}{operator+=()} */ -/*! \fn void Qt3DCore::swap(QCircularBuffer<T> &lhs, QCircularBuffer<T> &rhs) +/* \fn void Qt3DCore::swap(QCircularBuffer<T> &lhs, QCircularBuffer<T> &rhs) Swaps the contents of the circular buffer \a lhs with the contents of \a rhs. */ -/*! \fn bool Qt3DCore::operator<(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) +/* \fn bool Qt3DCore::operator<(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) Returns \c true if \a lhs is lexographically less than \a rhs. This is equivalent to calling \c{return std::lexicographical_compare(lhs.begin(), lhs.end(), rhs.begin(), rhs.end())}. */ -/*! \fn bool Qt3DCore::operator>(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) +/* \fn bool Qt3DCore::operator>(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) Returns \c true if \a rhs is lexographically less than \a lhs. */ -/*! \fn bool Qt3DCore::operator>=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) +/* \fn bool Qt3DCore::operator>=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) Returns \c true if \a lhs is lexographically less than or equal to \a rhs. */ -/*! \fn bool Qt3DCore::operator<=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) +/* \fn bool Qt3DCore::operator<=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs) Returns \c true if \a lhs is lexographically less than or equal to \a rhs. */ -/*! \typedef Qt3DCore::QCircularBuffer::Iterator +/* \typedef Qt3DCore::QCircularBuffer::Iterator Qt-style synonym for \l iterator. */ -/*! \typedef Qt3DCore::QCircularBuffer::ConstIterator +/* \typedef Qt3DCore::QCircularBuffer::ConstIterator Qt-style synonym for \l const_iterator. */ -/*! \typedef Qt3DCore::QCircularBuffer::const_pointer +/* \typedef Qt3DCore::QCircularBuffer::const_pointer Typedef for const T *. Provided for STL compatibility. */ -/*! \typedef Qt3DCore::QCircularBuffer::const_reference +/* \typedef Qt3DCore::QCircularBuffer::const_reference Typedef for T &. Provided for STL compatibility. */ -/*! \typedef Qt3DCore::QCircularBuffer::difference_type +/* \typedef Qt3DCore::QCircularBuffer::difference_type Typedef for ptrdiff_t. Provided for STL compatibility. */ -/*! \typedef Qt3DCore::QCircularBuffer::pointer +/* \typedef Qt3DCore::QCircularBuffer::pointer Typedef for T *. Provided for STL compatibility. */ -/*! \typedef Qt3DCore::QCircularBuffer::reference +/* \typedef Qt3DCore::QCircularBuffer::reference Typedef for T &. Provided for STL compatibility. */ -/*! \typedef Qt3DCore::QCircularBuffer::size_type +/* \typedef Qt3DCore::QCircularBuffer::size_type Typedef for int. Provided for STL compatibility. */ -/*! \typedef Qt3DCore::QCircularBuffer::value_type +/* \typedef Qt3DCore::QCircularBuffer::value_type Typedef for T. Provided for STL compatibility. */ -/*! \typedef Qt3DCore::QCircularBuffer::array_range +/* \typedef Qt3DCore::QCircularBuffer::array_range Typedef for QPair<T*,int>. The first element is a pointer to the first element of an array of T. The second element is the number @@ -1169,25 +1169,25 @@ \sa data(), dataOne(), dataTwo() */ -/*! \typedef Qt3DCore::QCircularBuffer::const_array_range +/* \typedef Qt3DCore::QCircularBuffer::const_array_range Typedef for QPair<const T*,int>. The first element is a pointer to the first element of an array of const T. The second element is the number of elements in the array. */ -/*! \typedef Qt3DCore::QCircularBuffer::ArrayRange +/* \typedef Qt3DCore::QCircularBuffer::ArrayRange Qt-style synonym for \l array_range. */ -/*! \typedef Qt3DCore::QCircularBuffer::ConstArrayRange +/* \typedef Qt3DCore::QCircularBuffer::ConstArrayRange Qt-style synonym for \l const_array_range. */ -/*! \class Qt3DCore::QCircularBuffer::iterator +/* \class Qt3DCore::QCircularBuffer::iterator \inmodule Qt3DCore \brief The Qt3DCore::QCircularBuffer::iterator class provides an STL-style non-const iterator for QCircularBuffer. @@ -1197,33 +1197,33 @@ \sa begin(), end(), const_iterator */ -/*! \typedef Qt3DCore::QCircularBuffer::iterator::iterator_category +/* \typedef Qt3DCore::QCircularBuffer::iterator::iterator_category A synonym for \e {std::random_access_iterator_tag} indicating this iterator is a random access iterator. */ -/*! \typedef Qt3DCore::QCircularBuffer::iterator::difference_type +/* \typedef Qt3DCore::QCircularBuffer::iterator::difference_type \internal */ -/*! \typedef Qt3DCore::QCircularBuffer::iterator::value_type +/* \typedef Qt3DCore::QCircularBuffer::iterator::value_type \internal */ -/*! \typedef Qt3DCore::QCircularBuffer::iterator::pointer +/* \typedef Qt3DCore::QCircularBuffer::iterator::pointer \internal */ -/*! \typedef Qt3DCore::QCircularBuffer::iterator::reference +/* \typedef Qt3DCore::QCircularBuffer::iterator::reference \internal */ -/*! \fn Qt3DCore::QCircularBuffer::iterator::iterator() +/* \fn Qt3DCore::QCircularBuffer::iterator::iterator() Constructs an uninitialized iterator. @@ -1234,12 +1234,12 @@ \sa begin(), end() */ -/*! \fn Qt3DCore::QCircularBuffer::iterator::iterator(QCircularBuffer<T> *buffer, int index) +/* \fn Qt3DCore::QCircularBuffer::iterator::iterator(QCircularBuffer<T> *buffer, int index) \internal */ -/*! \fn T &Qt3DCore::QCircularBuffer::iterator::operator*() const +/* \fn T &Qt3DCore::QCircularBuffer::iterator::operator*() const Returns a modifiable reference to the current item. @@ -1249,14 +1249,14 @@ \sa operator->() */ -/*! \fn T *Qt3DCore::QCircularBuffer::iterator::operator->() const +/* \fn T *Qt3DCore::QCircularBuffer::iterator::operator->() const Returns a pointer to the current item. \sa operator*() */ -/*! \fn T &Qt3DCore::QCircularBuffer::iterator::operator[](int j) const +/* \fn T &Qt3DCore::QCircularBuffer::iterator::operator[](int j) const Returns a modifiable reference to the item at position *this + \a{j}. @@ -1267,7 +1267,7 @@ \sa operator+() */ -/*! +/* \fn bool Qt3DCore::QCircularBuffer::iterator::operator==(const iterator &other) const Returns \c true if \a other points to the same item as this @@ -1276,7 +1276,7 @@ \sa operator!=() */ -/*! +/* \fn bool Qt3DCore::QCircularBuffer::iterator::operator!=(const iterator &other) const Returns \c true if \a other points to a different item than this @@ -1285,35 +1285,35 @@ \sa operator==() */ -/*! +/* \fn bool Qt3DCore::QCircularBuffer::iterator::operator<(const iterator& other) const Returns \c true if the item pointed to by this iterator occurs before the item pointed to by the \a other iterator. */ -/*! +/* \fn bool Qt3DCore::QCircularBuffer::iterator::operator<=(const iterator& other) const Returns \c true if the item pointed to by this iterator occurs before or at the same position as the item pointed to by the \a other iterator. */ -/*! +/* \fn bool Qt3DCore::QCircularBuffer::iterator::operator>(const iterator& other) const Returns \c true if the item pointed to by this iterator occurs after the item pointed to by the \a other iterator. */ -/*! +/* \fn bool Qt3DCore::QCircularBuffer::iterator::operator>=(const iterator& other) const Returns \c true if the item pointed to by this iterator occurs after or at the same position as the item pointed to by the \a other iterator. */ -/*! \fn Qt3DCore::QCircularBuffer::iterator &Qt3DCore::QCircularBuffer::iterator::operator++() +/* \fn Qt3DCore::QCircularBuffer::iterator &Qt3DCore::QCircularBuffer::iterator::operator++() The prefix ++ operator (\c{++it}) advances the iterator to the next item in the circular buffer and returns an iterator to the new current @@ -1324,7 +1324,7 @@ \sa operator--() */ -/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator++(int) +/* \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator++(int) \overload @@ -1333,7 +1333,7 @@ current item. */ -/*! \fn Qt3DCore::QCircularBuffer::iterator &Qt3DCore::QCircularBuffer::iterator::operator--() +/* \fn Qt3DCore::QCircularBuffer::iterator &Qt3DCore::QCircularBuffer::iterator::operator--() The prefix -- operator (\c{--it}) makes the preceding item the current item, and returns an iterator to the new current item. @@ -1343,7 +1343,7 @@ \sa operator++() */ -/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator--(int) +/* \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator--(int) \overload @@ -1351,7 +1351,7 @@ the current item, and returns an iterator to the previously current item. */ -/*! \fn Qt3DCore::QCircularBuffer::iterator &Qt3DCore::QCircularBuffer::iterator::operator+=(int j) +/* \fn Qt3DCore::QCircularBuffer::iterator &Qt3DCore::QCircularBuffer::iterator::operator+=(int j) Advances the iterator by \a j items. (If \a j is negative, the iterator goes backward.) @@ -1359,7 +1359,7 @@ \sa operator-=(), operator+() */ -/*! \fn Qt3DCore::QCircularBuffer::iterator &Qt3DCore::QCircularBuffer::iterator::operator-=(int j) +/* \fn Qt3DCore::QCircularBuffer::iterator &Qt3DCore::QCircularBuffer::iterator::operator-=(int j) Makes the iterator go back by \a j items. (If \a j is negative, the iterator goes forward.) @@ -1367,7 +1367,7 @@ \sa operator+=(), operator-() */ -/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator+(int j) const +/* \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator+(int j) const Returns an iterator to the item at \a j positions forward from this iterator. (If \a j is negative, the iterator goes backward.) @@ -1375,7 +1375,7 @@ \sa operator-(), operator+=() */ -/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator-(int j) const +/* \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator-(int j) const Returns an iterator to the item at \a j positions backward from this iterator. (If \a j is negative, the iterator goes forward.) @@ -1383,14 +1383,14 @@ \sa operator+(), operator-=() */ -/*! \fn int Qt3DCore::QCircularBuffer::iterator::operator-(iterator other) const +/* \fn int Qt3DCore::QCircularBuffer::iterator::operator-(iterator other) const Returns the number of items between the item pointed to by \a other and the item pointed to by this iterator. */ -/*! \class Qt3DCore::QCircularBuffer::const_iterator +/* \class Qt3DCore::QCircularBuffer::const_iterator \inmodule Qt3DCore \brief The Qt3DCore::QCircularBuffer::const_iterator class provides an STL-style const iterator for QCircularBuffer. @@ -1400,33 +1400,33 @@ \sa constBegin(), constEnd(), iterator */ -/*! \typedef Qt3DCore::QCircularBuffer::const_iterator::iterator_category +/* \typedef Qt3DCore::QCircularBuffer::const_iterator::iterator_category A synonym for \e {std::random_access_iterator_tag} indicating this iterator is a random access iterator. */ -/*! \typedef Qt3DCore::QCircularBuffer::const_iterator::difference_type +/* \typedef Qt3DCore::QCircularBuffer::const_iterator::difference_type \internal */ -/*! \typedef Qt3DCore::QCircularBuffer::const_iterator::value_type +/* \typedef Qt3DCore::QCircularBuffer::const_iterator::value_type \internal */ -/*! \typedef Qt3DCore::QCircularBuffer::const_iterator::pointer +/* \typedef Qt3DCore::QCircularBuffer::const_iterator::pointer \internal */ -/*! \typedef Qt3DCore::QCircularBuffer::const_iterator::reference +/* \typedef Qt3DCore::QCircularBuffer::const_iterator::reference \internal */ -/*! \fn Qt3DCore::QCircularBuffer::const_iterator::const_iterator() +/* \fn Qt3DCore::QCircularBuffer::const_iterator::const_iterator() Constructs an uninitialized const iterator. @@ -1437,26 +1437,26 @@ \sa begin(), end() */ -/*! \fn Qt3DCore::QCircularBuffer::const_iterator::const_iterator(const iterator &other) +/* \fn Qt3DCore::QCircularBuffer::const_iterator::const_iterator(const iterator &other) \internal */ -/*! \fn const T &Qt3DCore::QCircularBuffer::const_iterator::operator*() const +/* \fn const T &Qt3DCore::QCircularBuffer::const_iterator::operator*() const Returns a const reference to the current item. \sa operator->() */ -/*! \fn const T *Qt3DCore::QCircularBuffer::const_iterator::operator->() const +/* \fn const T *Qt3DCore::QCircularBuffer::const_iterator::operator->() const Returns a pointer to the current item. \sa operator*() */ -/*! \fn const T &Qt3DCore::QCircularBuffer::const_iterator::operator[](int j) const +/* \fn const T &Qt3DCore::QCircularBuffer::const_iterator::operator[](int j) const Returns a const reference to the item at position *this + \a{j}. @@ -1467,7 +1467,7 @@ \sa operator+() */ -/*! +/* \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator==(const const_iterator &other) const Returns \c true if \a other points to the same item as this @@ -1476,7 +1476,7 @@ \sa operator!=() */ -/*! +/* \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator!=(const const_iterator &other) const Returns \c true if \a other points to a different item than this @@ -1485,35 +1485,35 @@ \sa operator==() */ -/*! +/* \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator<(const const_iterator& other) const Returns \c true if the item pointed to by this iterator occurs before the item pointed to by the \a other iterator. */ -/*! +/* \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator<=(const const_iterator& other) const Returns \c true if the item pointed to by this iterator occurs before, or at the same position as the item pointed to by the \a other iterator. */ -/*! +/* \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator>(const const_iterator& other) const Returns \c true if the item pointed to by this iterator occurs after the item pointed to by the \a other iterator. */ -/*! +/* \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator>=(const const_iterator& other) const Returns \c true if the item pointed to by this iterator occurs after, or at the same position as the item pointed to by the \a other iterator. */ -/*! \fn Qt3DCore::QCircularBuffer::const_iterator &Qt3DCore::QCircularBuffer::const_iterator::operator++() +/* \fn Qt3DCore::QCircularBuffer::const_iterator &Qt3DCore::QCircularBuffer::const_iterator::operator++() The prefix ++ operator (\c{++it}) advances the iterator to the next item in the circular buffer and returns an iterator to the new current @@ -1524,7 +1524,7 @@ \sa operator--() */ -/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::const_iterator::operator++(int) +/* \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::const_iterator::operator++(int) \overload @@ -1533,7 +1533,7 @@ current item. */ -/*! \fn Qt3DCore::QCircularBuffer::const_iterator &Qt3DCore::QCircularBuffer::const_iterator::operator--() +/* \fn Qt3DCore::QCircularBuffer::const_iterator &Qt3DCore::QCircularBuffer::const_iterator::operator--() The prefix -- operator (\c{--it}) makes the preceding item the current and returns an iterator to the new current item. @@ -1543,7 +1543,7 @@ \sa operator++() */ -/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::const_iterator::operator--(int) +/* \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::const_iterator::operator--(int) \overload @@ -1551,7 +1551,7 @@ current and returns an iterator to the previously current item. */ -/*! \fn Qt3DCore::QCircularBuffer::const_iterator &Qt3DCore::QCircularBuffer::const_iterator::operator+=(int j) +/* \fn Qt3DCore::QCircularBuffer::const_iterator &Qt3DCore::QCircularBuffer::const_iterator::operator+=(int j) Advances the iterator by \a j items. (If \a j is negative, the iterator goes backward.) @@ -1559,7 +1559,7 @@ \sa operator-=(), operator+() */ -/*! \fn Qt3DCore::QCircularBuffer::const_iterator &Qt3DCore::QCircularBuffer::const_iterator::operator-=(int j) +/* \fn Qt3DCore::QCircularBuffer::const_iterator &Qt3DCore::QCircularBuffer::const_iterator::operator-=(int j) Makes the iterator go back by \a j items. (If \a j is negative, the iterator goes forward.) @@ -1567,7 +1567,7 @@ \sa operator+=(), operator-() */ -/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::const_iterator::operator+(int j) const +/* \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::const_iterator::operator+(int j) const Returns an iterator to the item at \a j positions forward from this iterator. (If \a j is negative, the iterator goes backward.) @@ -1575,7 +1575,7 @@ \sa operator-(), operator+=() */ -/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::const_iterator::operator-(int j) const +/* \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::const_iterator::operator-(int j) const Returns an iterator to the item at \a j positions backward from this iterator. (If \a j is negative, the iterator goes forward.) @@ -1583,7 +1583,7 @@ \sa operator+(), operator-=() */ -/*! \fn int Qt3DCore::QCircularBuffer::const_iterator::operator-(const_iterator other) const +/* \fn int Qt3DCore::QCircularBuffer::const_iterator::operator-(const_iterator other) const Returns the number of items between the item pointed to by \a other and the item pointed to by this iterator. |