summaryrefslogtreecommitdiffstats
path: root/src/doc/src/qcircularbuffer.qdoc
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2015-10-30 14:18:19 +0100
committerJędrzej Nowacki <jedrzej.nowacki@theqtcompany.com>2015-11-06 08:05:36 +0000
commit872efa5619d20a421142a88e1a38f131c08d44d1 (patch)
tree2f7332e6beb78cadd61e3333147d13e8ebabfbda /src/doc/src/qcircularbuffer.qdoc
parent537dc6222a5da789153e7c32953d3d7a5ca11980 (diff)
Doc: Documentation clean up
- Changed 'Qt3D' references to 'Qt 3D'. - Fixed incorrect \inqmlmodule instances. - Fixed broken \printuntil instances in the example docs. - Updated the namespace qualifier for a few class references. Change-Id: I250afe6843b10ed520f9ce5d7465203cc5c212c1 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Diffstat (limited to 'src/doc/src/qcircularbuffer.qdoc')
-rw-r--r--src/doc/src/qcircularbuffer.qdoc380
1 files changed, 190 insertions, 190 deletions
diff --git a/src/doc/src/qcircularbuffer.qdoc b/src/doc/src/qcircularbuffer.qdoc
index 080eeab98..d34e72e53 100644
--- a/src/doc/src/qcircularbuffer.qdoc
+++ b/src/doc/src/qcircularbuffer.qdoc
@@ -35,7 +35,7 @@
****************************************************************************/
/*!
- \class Qt3D::QCircularBuffer
+ \class Qt3DCore::QCircularBuffer
\inmodule Qt3DCore
\brief A template class providing a dynamic circular array.
@@ -110,7 +110,7 @@
Another way to access the data stored in a QCircularBuffer is to call data(),
or dataOne() and dataTwo() depending on if the buffer is linearized or not.
See the discussion in isLinearised() for more information. The data() function
- returns a Qt3D::QCircularBuffer::array_range object describing the array of items stored
+ returns a Qt3DCore::QCircularBuffer::array_range object describing the array of items stored
in the QCircularBuffer. You can use the pointer in the array_range to
directly access and modify the elements stored in the circular buffer. The pointer is also
useful if you need to pass a QCircularBuffer to a function that accepts a plain
@@ -184,26 +184,26 @@
support \c operator==(). These requirements are documented on a
per-function basis.
- QCircularBuffer provides \l{STL-Style Iterators} (\l {Qt3D::QCircularBuffer::}{const_iterator})
- and \l {Qt3D::QCircularBuffer::}{iterator}). In practice, these are rarely used,
+ QCircularBuffer provides \l{STL-Style Iterators} (\l {Qt3DCore::QCircularBuffer::}{const_iterator})
+ and \l {Qt3DCore::QCircularBuffer::}{iterator}). In practice, these are rarely used,
because you can use indexes into the QCircularBuffer.
QCircularBuffer does \e not support inserting, prepending, appending, or
replacing with references to its own values. Doing so will cause your
application to abort with an error message.
- \sa Qt3D::QCircularBuffer::iterator, Qt3D::QCircularBuffer::const_iterator,
+ \sa Qt3DCore::QCircularBuffer::iterator, Qt3DCore::QCircularBuffer::const_iterator,
QVector, QList, QLinkedList
*/
-/*! \fn Qt3D::QCircularBuffer::QCircularBuffer()
+/*! \fn Qt3DCore::QCircularBuffer::QCircularBuffer()
Constructs an empty circular buffer with zero capacity.
\sa resize(), setCapacity()
*/
-/*! \fn Qt3D::QCircularBuffer::QCircularBuffer(int capacity)
+/*! \fn Qt3DCore::QCircularBuffer::QCircularBuffer(int capacity)
Constructs an empty circular buffer with an initial capacity of \a capacity
elements.
@@ -211,7 +211,7 @@
\sa resize(), setCapacity()
*/
-/*! \fn Qt3D::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.
@@ -221,7 +221,7 @@
\sa resize(), setCapacity(), fill()
*/
-/*! \fn Qt3D::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.
@@ -231,7 +231,7 @@
\sa resize(), setCapacity(), fill()
*/
-/*! \fn Qt3D::QCircularBuffer::QCircularBuffer(const QCircularBuffer<T> &other)
+/*! \fn Qt3DCore::QCircularBuffer::QCircularBuffer(const QCircularBuffer<T> &other)
Constructs a copy of \a other.
@@ -243,18 +243,18 @@
\sa operator=()
*/
-/*! \fn Qt3D::QCircularBuffer::~QCircularBuffer()
+/*! \fn Qt3DCore::QCircularBuffer::~QCircularBuffer()
Destroys the circular buffer.
*/
-/*! \fn QCircularBuffer &Qt3D::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 Qt3D::QCircularBuffer::iterator Qt3D::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.
@@ -262,12 +262,12 @@
\sa constBegin(), end()
*/
-/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::QCircularBuffer::begin() const
+/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::begin() const
\overload
*/
-/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::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.
@@ -275,7 +275,7 @@
\sa begin(), constEnd()
*/
-/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::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.
@@ -283,12 +283,12 @@
\sa begin(), constEnd()
*/
-/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::QCircularBuffer::end() const
+/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::end() const
\overload
*/
-/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::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.
@@ -296,7 +296,7 @@
\sa constBegin(), end()
*/
-/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::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
@@ -305,7 +305,7 @@
\sa insert(), remove()
*/
-/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::QCircularBuffer::erase(const_iterator begin, const_iterator end)
+/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::erase(const_iterator begin, const_iterator end)
\overload
@@ -314,65 +314,65 @@
before the call.
*/
-/*! \fn void Qt3D::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 Qt3D::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 Qt3D::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 Qt3D::QCircularBuffer::pop_front()
+/*! \fn void Qt3DCore::QCircularBuffer::pop_front()
This function is provided for STL compatibility. It is equivalent
to erase(begin()).
*/
-/*! \fn bool Qt3D::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 Qt3D::QCircularBuffer::reference Qt3D::QCircularBuffer::front()
+/*! \fn Qt3DCore::QCircularBuffer::reference Qt3DCore::QCircularBuffer::front()
This function is provided for STL compatibility. It is equivalent
to first().
*/
-/*! \fn Qt3D::QCircularBuffer::const_reference Qt3D::QCircularBuffer::front() const
+/*! \fn Qt3DCore::QCircularBuffer::const_reference Qt3DCore::QCircularBuffer::front() const
\overload
*/
-/*! \fn Qt3D::QCircularBuffer::reference Qt3D::QCircularBuffer::back()
+/*! \fn Qt3DCore::QCircularBuffer::reference Qt3DCore::QCircularBuffer::back()
This function is provided for STL compatibility. It is equivalent
to last().
*/
-/*! \fn Qt3D::QCircularBuffer::const_reference Qt3D::QCircularBuffer::back() const
+/*! \fn Qt3DCore::QCircularBuffer::const_reference Qt3DCore::QCircularBuffer::back() const
\overload
*/
-/*! \fn int Qt3D::QCircularBuffer::refCount() const
+/*! \fn int Qt3DCore::QCircularBuffer::refCount() const
Returns the number of shallow copies that exist of this circular buffer.
*/
-/*! \fn Qt3D::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.
@@ -386,7 +386,7 @@
\sa operator<<(), operator+=(), prepend(), insert()
*/
-/*! \fn const T &Qt3D::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.
@@ -396,7 +396,7 @@
\sa value(), operator[]()
*/
-/*! \fn T &Qt3D::QCircularBuffer::operator[](int i)
+/*! \fn T &Qt3DCore::QCircularBuffer::operator[](int i)
Returns the item at index position \a i as a modifiable reference.
@@ -409,14 +409,14 @@
\sa at(), value()
*/
-/*! \fn const T &Qt3D::QCircularBuffer::operator[](int i) const
+/*! \fn const T &Qt3DCore::QCircularBuffer::operator[](int i) const
\overload
Same as at(\a i).
*/
-/*! \fn int Qt3D::QCircularBuffer::capacity() const
+/*! \fn int Qt3DCore::QCircularBuffer::capacity() const
Returns the maximum number of elements that can be stored in
the circular buffer.
@@ -424,7 +424,7 @@
\sa setCapacity(), size()
*/
-/*! \fn void Qt3D::QCircularBuffer::clear()
+/*! \fn void Qt3DCore::QCircularBuffer::clear()
Removes all elements from the circular buffer so that the size is
zero. The capacity is unchanged.
@@ -432,7 +432,7 @@
\sa isEmpty()
*/
-/*! \fn bool Qt3D::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.
@@ -443,7 +443,7 @@
\sa indexOf(), count()
*/
-/*! \fn int Qt3D::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.
@@ -453,16 +453,16 @@
\sa contains(), indexOf()
*/
-/*! \fn int Qt3D::QCircularBuffer::count() const
+/*! \fn int Qt3DCore::QCircularBuffer::count() const
\overload
Same as size().
*/
-/*! \fn Qt3D::QCircularBuffer::array_range Qt3D::QCircularBuffer::data()
+/*! \fn Qt3DCore::QCircularBuffer::array_range Qt3DCore::QCircularBuffer::data()
- Returns a Qt3D::QCircularBuffer::array_range describing the internal array of data. If
+ Returns a Qt3DCore::QCircularBuffer::array_range describing the internal array of data. If
the circular buffer is non-linearized, then this function causes it to be
linearized. If the cost of linearisation is too high for your use case, then
you should consider using the dataOne() and dataTwo() functions instead.
@@ -473,7 +473,7 @@
\sa constData(), dataOne(), dataTwo(), isLinearised()
*/
-/*! \fn Qt3D::QCircularBuffer::const_array_range Qt3D::QCircularBuffer::data() const
+/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::data() const
\overload
@@ -482,9 +482,9 @@
constness.
*/
-/*! \fn Qt3D::QCircularBuffer::const_array_range Qt3D::QCircularBuffer::constData() const
+/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::constData() const
- Returns a Qt3D::QCircularBuffer::const_array_range describing the internal array of
+ Returns a Qt3DCore::QCircularBuffer::const_array_range describing the internal array of
data.
If the circular buffer is non-linearized then the pointer and array size
@@ -497,14 +497,14 @@
\sa data(), constDataOne(), constDataTwo(), isLinearised()
*/
-/*! \fn Qt3D::QCircularBuffer::array_range Qt3D::QCircularBuffer::dataOne()
+/*! \fn Qt3DCore::QCircularBuffer::array_range Qt3DCore::QCircularBuffer::dataOne()
- Returns a Qt3D::QCircularBuffer::array_range describing the first internal array of
+ Returns a Qt3DCore::QCircularBuffer::array_range describing the first internal array of
contiguous data. If the circular buffer is linearized, then this function is
equivalent to calling data(). If the circular buffer is non-linearized then
the returned array range will describe a subset of the data contained in the
circular buffer. This subset will consist of the earliest (lowest index) items
- in the buffer. To obtain a Qt3D::QCircularBuffer::array_range for the remainder
+ in the buffer. To obtain a Qt3DCore::QCircularBuffer::array_range for the remainder
of the data, use the dataTwo() function.
If the circular buffer is empty, then the pointer and array size returned
@@ -513,22 +513,22 @@
\sa constDataOne(), dataTwo(), data(), isLinearised()
*/
-/*! \fn Qt3D::QCircularBuffer::const_array_range Qt3D::QCircularBuffer::dataOne() const
+/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::dataOne() const
\overload
- Unlike data() this function always returns a valid Qt3D::QCircularBuffer::const_array_range
+ Unlike data() this function always returns a valid Qt3DCore::QCircularBuffer::const_array_range
(unless the circular buffer is empty).
*/
-/*! \fn Qt3D::QCircularBuffer::const_array_range Qt3D::QCircularBuffer::constDataOne() const
+/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::constDataOne() const
- Returns a Qt3D::QCircularBuffer::const_array_range describing the first internal array of
+ Returns a Qt3DCore::QCircularBuffer::const_array_range describing the first internal array of
contiguous data. If the circular buffer is linearized, then this function is
equivalent to calling constData(). If the circular buffer is non-linearized, then
the returned array range will describe a subset of the data contained in the
circular buffer. This subset will consist of the earliest (lowest index) items
- in the buffer. To obtain a Qt3D::QCircularBuffer::const_array_range for the remainder
+ in the buffer. To obtain a Qt3DCore::QCircularBuffer::const_array_range for the remainder
of the data, use the constDataTwo() function.
If the circular buffer is empty, then the pointer and array size returned
@@ -537,9 +537,9 @@
\sa dataOne(), constDataTwo(), constData(), isLinearised()
*/
-/*! \fn Qt3D::QCircularBuffer::array_range Qt3D::QCircularBuffer::dataTwo()
+/*! \fn Qt3DCore::QCircularBuffer::array_range Qt3DCore::QCircularBuffer::dataTwo()
- Returns a Qt3D::QCircularBuffer::array_range describing the first internal array of
+ Returns a Qt3DCore::QCircularBuffer::array_range describing the first internal array of
contiguous data. If the circular buffer is linearized, then the pointer and array size
returned will both be 0 since all the data will be contained in the array
described by calling the dataOne() function.
@@ -547,14 +547,14 @@
\sa dataOne(), constDataTwo(), data(), isLinearised()
*/
-/*! \fn Qt3D::QCircularBuffer::const_array_range Qt3D::QCircularBuffer::dataTwo() const
+/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::dataTwo() const
\overload
*/
-/*! \fn Qt3D::QCircularBuffer::const_array_range Qt3D::QCircularBuffer::constDataTwo() const
+/*! \fn Qt3DCore::QCircularBuffer::const_array_range Qt3DCore::QCircularBuffer::constDataTwo() const
- Returns a Qt3D::QCircularBuffer::const_array_range describing the first internal array of
+ Returns a Qt3DCore::QCircularBuffer::const_array_range describing the first internal array of
contiguous data. If the circular buffer is linearized, then the pointer and array size
returned will both be 0 since all the data will be contained in the array
described by calling the dataOne() function.
@@ -562,7 +562,7 @@
\sa constDataOne(), dataTwo(), constData(), isLinearised()
*/
-/*! \fn bool Qt3D::QCircularBuffer::endsWith(const T &value) const
+/*! \fn bool Qt3DCore::QCircularBuffer::endsWith(const T &value) const
Returns true if this circular buffer is not empty and its last
item is equal to \a value; otherwise returns false.
@@ -570,7 +570,7 @@
\sa isEmpty(), last(), startsWith()
*/
-/*! \fn QCircularBuffer<T>& Qt3D::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
@@ -584,7 +584,7 @@
\sa resize()
*/
-/*! \fn T &Qt3D::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.
@@ -592,12 +592,12 @@
\sa last(), isEmpty()
*/
-/*! \fn const T &Qt3D::QCircularBuffer::first() const
+/*! \fn const T &Qt3DCore::QCircularBuffer::first() const
\overload
*/
-/*! \fn int Qt3D::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
@@ -606,7 +606,7 @@
\sa sizeAvailable(), capacity(), isEmpty(), isFull(), size()
*/
-/*! \fn static QCircularBuffer<T> Qt3D::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
@@ -618,7 +618,7 @@
\sa fromVector(), toList(), toVector()
*/
-/*! \fn static QCircularBuffer<T> Qt3D::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
@@ -627,7 +627,7 @@
\sa fromList(), toVector(), toList()
*/
-/*! \fn int Qt3D::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.
@@ -642,7 +642,7 @@
\sa lastIndexOf(), contains()
*/
-/*! \fn void Qt3D::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
@@ -674,7 +674,7 @@
\sa append(), prepend(), remove()
*/
-/*! \fn void Qt3D::QCircularBuffer::insert(int i, int count, const T &value)
+/*! \fn void Qt3DCore::QCircularBuffer::insert(int i, int count, const T &value)
\overload
@@ -708,7 +708,7 @@
\sa append(), prepend(), remove()
*/
-/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::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
@@ -719,7 +719,7 @@
\sa append(), prepend(), remove()
*/
-/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::QCircularBuffer::insert(const_iterator before, const T &value)
+/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::insert(const_iterator before, const T &value)
\overload
@@ -729,21 +729,21 @@
\sa append(), prepend(), remove()
*/
-/*! \fn bool Qt3D::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 Qt3D::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 Qt3D::QCircularBuffer::isLinearised() const
+/*! \fn bool Qt3DCore::QCircularBuffer::isLinearised() const
Returns true if the circular buffer is linearized; otherwise returns false.
@@ -801,7 +801,7 @@
(perhaps for a plain C++ function call) then you can use the data()
function. If the circular buffer is non-linearized, then the data()
function will linearize it for you before returning a
- Qt3D::QCircularBuffer::array_range describing the array.
+ Qt3DCore::QCircularBuffer::array_range describing the array.
To prevent the cost of the linearisation process, you can instead
call the dataOne() and dataTwo() functions to obtain the two arrays
@@ -817,7 +817,7 @@
\sa linearise(), data(), dataOne(), dataTwo()
*/
-/*! \fn T &Qt3D::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.
@@ -825,12 +825,12 @@
\sa first(), isEmpty()
*/
-/*! \fn const T &Qt3D::QCircularBuffer::last() const
+/*! \fn const T &Qt3DCore::QCircularBuffer::last() const
\overload
*/
-/*! \fn int Qt3D::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
@@ -846,7 +846,7 @@
\sa indexOf()
*/
-/*! \fn void Qt3D::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.
@@ -856,7 +856,7 @@
\sa isLinearised()
*/
-/*! \fn void Qt3D::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.
@@ -870,14 +870,14 @@
\sa operator<<(), operator+=(), append(), insert()
*/
-/*! \fn void Qt3D::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 Qt3D::QCircularBuffer::remove(int i, int count)
+/*! \fn void Qt3DCore::QCircularBuffer::remove(int i, int count)
\overload
@@ -887,7 +887,7 @@
\sa insert(), replace(), fill()
*/
-/*! \fn void Qt3D::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.
@@ -897,7 +897,7 @@
\sa operator[](), remove()
*/
-/*! \fn void Qt3D::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().
@@ -905,7 +905,7 @@
\sa setCapacity()
*/
-/*! \fn void Qt3D::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
@@ -916,21 +916,21 @@
\sa size(), insert(), remove(), capacity(), setCapacity()
*/
-/*! \fn void Qt3D::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 Qt3D::QCircularBuffer::size() const
+/*! \fn int Qt3DCore::QCircularBuffer::size() const
Returns the number of items in the circular buffer.
\sa sizeAvailable(), capacity(), resize()
*/
-/*! \fn int Qt3D::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
@@ -939,7 +939,7 @@
\sa capacity(), isEmpty(), isFull(), size(), freeSize()
*/
-/*! \fn void Qt3D::QCircularBuffer::squeeze()
+/*! \fn void Qt3DCore::QCircularBuffer::squeeze()
Releases any unused memory from the circular buffer. It is equivalent
to calling setCapacity(size()).
@@ -947,7 +947,7 @@
\sa setCapacity(), size(), resize(), sizeAvailable()
*/
-/*! \fn bool Qt3D::QCircularBuffer::startsWith(const T &value) const
+/*! \fn bool Qt3DCore::QCircularBuffer::startsWith(const T &value) const
Returns true if the circular buffer is not empty and its first
item is equal to \a value; otherwise returns false.
@@ -955,7 +955,7 @@
\sa isEmpty(), first(), endsWith()
*/
-/*! \fn QList<T> Qt3D::QCircularBuffer::toList() const
+/*! \fn QList<T> Qt3DCore::QCircularBuffer::toList() const
Returns a QList object with the data contained in this QCircularBuffer.
@@ -966,14 +966,14 @@
\sa fromList(), toVector()
*/
-/*! \fn QVector<T> Qt3D::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 Qt3D::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.
@@ -985,7 +985,7 @@
\sa at(), operator[]()
*/
-/*! \fn T Qt3D::QCircularBuffer::value(int i, const T &defaultValue) const
+/*! \fn T Qt3DCore::QCircularBuffer::value(int i, const T &defaultValue) const
\overload
@@ -993,7 +993,7 @@
\a defaultValue.
*/
-/*! \fn bool Qt3D::operator==(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs)
+/*! \fn bool Qt3DCore::operator==(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs)
Returns true if the circular buffer \a lhs is equal to \a rhs; otherwise
returns false.
@@ -1007,7 +1007,7 @@
\sa operator!=()
*/
-/*! \fn bool Qt3D::operator!=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs)
+/*! \fn bool Qt3DCore::operator!=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs)
Returns true if the circular buffer \a lhs is not equal to \a rhs; otherwise
returns false.
@@ -1021,7 +1021,7 @@
\sa operator==()
*/
-/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::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.
@@ -1029,7 +1029,7 @@
\sa operator+(), operator<<(), append()
*/
-/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::QCircularBuffer::operator+=(const QCircularBuffer<T>& other)
+/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator+=(const QCircularBuffer<T>& other)
\overload
@@ -1039,17 +1039,17 @@
\sa operator+(), operator<<(), append()
*/
-/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::QCircularBuffer::operator+=(const QVector<T>& other)
+/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator+=(const QVector<T>& other)
\overload
*/
-/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::QCircularBuffer::operator+=(const QList<T>& other)
+/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator+=(const QList<T>& other)
\overload
*/
-/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::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.
@@ -1057,7 +1057,7 @@
\sa operator+(), operator+=(), append()
*/
-/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::QCircularBuffer::operator<<(const QCircularBuffer<T>& other)
+/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator<<(const QCircularBuffer<T>& other)
\overload
@@ -1067,96 +1067,96 @@
\sa operator+(), operator+=(), append()
*/
-/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::QCircularBuffer::operator<<(const QVector<T>& other)
+/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator<<(const QVector<T>& other)
\overload
*/
-/*! \fn Qt3D::QCircularBuffer<T>& Qt3D::QCircularBuffer::operator<<(const QList<T>& other)
+/*! \fn Qt3DCore::QCircularBuffer<T>& Qt3DCore::QCircularBuffer::operator<<(const QList<T>& other)
\overload
*/
-/*! \fn Qt3D::QCircularBuffer<T> Qt3D::operator+(const QCircularBuffer<T>& lhs, const QCircularBuffer<T>& rhs)
+/*! \fn Qt3DCore::QCircularBuffer<T> Qt3DCore::operator+(const QCircularBuffer<T>& lhs, const QCircularBuffer<T>& rhs)
Returns a circular buffer object with capacity of lhs.size() + rhs.size() containing
the items from \a lhs followed by the items from \a rhs.
- \sa Qt3D::QCircularBuffer::operator+=()
+ \sa Qt3DCore::QCircularBuffer::operator+=()
*/
-/*! \fn void Qt3D::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 Qt3D::operator<(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs)
+/*! \fn bool Qt3DCore::operator<(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs)
Returns 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 Qt3D::operator>(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs)
+/*! \fn bool Qt3DCore::operator>(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs)
Returns true if \a rhs is lexographically less than \a lhs.
*/
-/*! \fn bool Qt3D::operator>=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs)
+/*! \fn bool Qt3DCore::operator>=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs)
Returns true if \a lhs is lexographically less than or equal to \a rhs.
*/
-/*! \fn bool Qt3D::operator<=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs)
+/*! \fn bool Qt3DCore::operator<=(const QCircularBuffer<T> &lhs, const QCircularBuffer<T> &rhs)
Returns true if \a lhs is lexographically less than or equal to \a rhs.
*/
-/*! \typedef Qt3D::QCircularBuffer::Iterator
+/*! \typedef Qt3DCore::QCircularBuffer::Iterator
- Qt-style synonym for Qt3D::QCircularBuffer::iterator.
+ Qt-style synonym for Qt3DCore::QCircularBuffer::iterator.
*/
-/*! \typedef Qt3D::QCircularBuffer::ConstIterator
+/*! \typedef Qt3DCore::QCircularBuffer::ConstIterator
- Qt-style synonym for Qt3D::QCircularBuffer::const_iterator.
+ Qt-style synonym for Qt3DCore::QCircularBuffer::const_iterator.
*/
-/*! \typedef Qt3D::QCircularBuffer::const_pointer
+/*! \typedef Qt3DCore::QCircularBuffer::const_pointer
Typedef for const T *. Provided for STL compatibility.
*/
-/*! \typedef Qt3D::QCircularBuffer::const_reference
+/*! \typedef Qt3DCore::QCircularBuffer::const_reference
Typedef for T &. Provided for STL compatibility.
*/
-/*! \typedef Qt3D::QCircularBuffer::difference_type
+/*! \typedef Qt3DCore::QCircularBuffer::difference_type
Typedef for ptrdiff_t. Provided for STL compatibility.
*/
-/*! \typedef Qt3D::QCircularBuffer::pointer
+/*! \typedef Qt3DCore::QCircularBuffer::pointer
Typedef for T *. Provided for STL compatibility.
*/
-/*! \typedef Qt3D::QCircularBuffer::reference
+/*! \typedef Qt3DCore::QCircularBuffer::reference
Typedef for T &. Provided for STL compatibility.
*/
-/*! \typedef Qt3D::QCircularBuffer::size_type
+/*! \typedef Qt3DCore::QCircularBuffer::size_type
Typedef for int. Provided for STL compatibility.
*/
-/*! \typedef Qt3D::QCircularBuffer::value_type
+/*! \typedef Qt3DCore::QCircularBuffer::value_type
Typedef for T. Provided for STL compatibility.
*/
-/*! \typedef Qt3D::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
@@ -1165,62 +1165,62 @@
\sa data(), dataOne(), dataTwo()
*/
-/*! \typedef Qt3D::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 Qt3D::QCircularBuffer::ArrayRange
+/*! \typedef Qt3DCore::QCircularBuffer::ArrayRange
- Qt-style synonym for Qt3D::QCircularBuffer::array_range.
+ Qt-style synonym for Qt3DCore::QCircularBuffer::array_range.
*/
-/*! \typedef Qt3D::QCircularBuffer::ConstArrayRange
+/*! \typedef Qt3DCore::QCircularBuffer::ConstArrayRange
- Qt-style synonym for Qt3D::QCircularBuffer::const_array_range.
+ Qt-style synonym for Qt3DCore::QCircularBuffer::const_array_range.
*/
-/*! \class Qt3D::QCircularBuffer::iterator
+/*! \class Qt3DCore::QCircularBuffer::iterator
\inmodule Qt3DCore
- \brief The Qt3D::QCircularBuffer::iterator class provides an STL-style non-const iterator for QCircularBuffer.
+ \brief The Qt3DCore::QCircularBuffer::iterator class provides an STL-style non-const iterator for QCircularBuffer.
QCircularBuffer provides both \l{STL-Style Iterators} and \l{Java-Style
Iterators}.
- \sa Qt3D::QCircularBuffer::begin(), Qt3D::QCircularBuffer::end(),
- Qt3D::QCircularBuffer::const_iterator
+ \sa Qt3DCore::QCircularBuffer::begin(), Qt3DCore::QCircularBuffer::end(),
+ Qt3DCore::QCircularBuffer::const_iterator
*/
-/*! \typedef Qt3D::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 Qt3D::QCircularBuffer::iterator::difference_type
+/*! \typedef Qt3DCore::QCircularBuffer::iterator::difference_type
\internal
*/
-/*! \typedef Qt3D::QCircularBuffer::iterator::value_type
+/*! \typedef Qt3DCore::QCircularBuffer::iterator::value_type
\internal
*/
-/*! \typedef Qt3D::QCircularBuffer::iterator::pointer
+/*! \typedef Qt3DCore::QCircularBuffer::iterator::pointer
\internal
*/
-/*! \typedef Qt3D::QCircularBuffer::iterator::reference
+/*! \typedef Qt3DCore::QCircularBuffer::iterator::reference
\internal
*/
-/*! \fn Qt3D::QCircularBuffer::iterator::iterator()
+/*! \fn Qt3DCore::QCircularBuffer::iterator::iterator()
Constructs an uninitialized iterator.
@@ -1228,15 +1228,15 @@
on an uninitialized iterator. Use operator=() to assign a value
to it before using it.
- \sa Qt3D::QCircularBuffer::begin() Qt3D::QCircularBuffer::end()
+ \sa Qt3DCore::QCircularBuffer::begin() Qt3DCore::QCircularBuffer::end()
*/
-/*! \fn Qt3D::QCircularBuffer::iterator::iterator(QCircularBuffer<T> *buffer, int index)
+/*! \fn Qt3DCore::QCircularBuffer::iterator::iterator(QCircularBuffer<T> *buffer, int index)
\internal
*/
-/*! \fn T &Qt3D::QCircularBuffer::iterator::operator*() const
+/*! \fn T &Qt3DCore::QCircularBuffer::iterator::operator*() const
Returns a modifiable reference to the current item.
@@ -1246,14 +1246,14 @@
\sa operator->()
*/
-/*! \fn T *Qt3D::QCircularBuffer::iterator::operator->() const
+/*! \fn T *Qt3DCore::QCircularBuffer::iterator::operator->() const
Returns a pointer to the current item.
\sa operator*()
*/
-/*! \fn T &Qt3D::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}.
@@ -1265,7 +1265,7 @@
*/
/*!
- \fn bool Qt3D::QCircularBuffer::iterator::operator==(const iterator &other) const
+ \fn bool Qt3DCore::QCircularBuffer::iterator::operator==(const iterator &other) const
Returns true if \a other points to the same item as this
iterator; otherwise returns false.
@@ -1274,7 +1274,7 @@
*/
/*!
- \fn bool Qt3D::QCircularBuffer::iterator::operator!=(const iterator &other) const
+ \fn bool Qt3DCore::QCircularBuffer::iterator::operator!=(const iterator &other) const
Returns true if \a other points to a different item than this
iterator; otherwise returns false.
@@ -1283,45 +1283,45 @@
*/
/*!
- \fn bool Qt3D::QCircularBuffer::iterator::operator<(const iterator& other) const
+ \fn bool Qt3DCore::QCircularBuffer::iterator::operator<(const iterator& other) const
Returns true if the item pointed to by this iterator occurs before
the item pointed to by the \a other iterator.
*/
/*!
- \fn bool Qt3D::QCircularBuffer::iterator::operator<=(const iterator& other) const
+ \fn bool Qt3DCore::QCircularBuffer::iterator::operator<=(const iterator& other) const
Returns 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 Qt3D::QCircularBuffer::iterator::operator>(const iterator& other) const
+ \fn bool Qt3DCore::QCircularBuffer::iterator::operator>(const iterator& other) const
Returns true if the item pointed to by this iterator occurs after
the item pointed to by the \a other iterator.
*/
/*!
- \fn bool Qt3D::QCircularBuffer::iterator::operator>=(const iterator& other) const
+ \fn bool Qt3DCore::QCircularBuffer::iterator::operator>=(const iterator& other) const
Returns 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 Qt3D::QCircularBuffer::iterator &Qt3D::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
item.
- Calling this function on Qt3D::QCircularBuffer::end() leads to undefined results.
+ Calling this function on Qt3DCore::QCircularBuffer::end() leads to undefined results.
\sa operator--()
*/
-/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::QCircularBuffer::iterator::operator++(int)
+/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator++(int)
\overload
@@ -1330,17 +1330,17 @@
current item.
*/
-/*! \fn Qt3D::QCircularBuffer::iterator &Qt3D::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.
- Calling this function on Qt3D::QCircularBuffer::begin() leads to undefined results.
+ Calling this function on Qt3DCore::QCircularBuffer::begin() leads to undefined results.
\sa operator++()
*/
-/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::QCircularBuffer::iterator::operator--(int)
+/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator--(int)
\overload
@@ -1348,7 +1348,7 @@
the current item, and returns an iterator to the previously current item.
*/
-/*! \fn Qt3D::QCircularBuffer::iterator &Qt3D::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.)
@@ -1356,7 +1356,7 @@
\sa operator-=(), operator+()
*/
-/*! \fn Qt3D::QCircularBuffer::iterator &Qt3D::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.)
@@ -1364,7 +1364,7 @@
\sa operator+=(), operator-()
*/
-/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::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.)
@@ -1372,7 +1372,7 @@
\sa operator-(), operator+=()
*/
-/*! \fn Qt3D::QCircularBuffer::iterator Qt3D::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.)
@@ -1380,51 +1380,51 @@
\sa operator+(), operator-=()
*/
-/*! \fn int Qt3D::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 Qt3D::QCircularBuffer::const_iterator
+/*! \class Qt3DCore::QCircularBuffer::const_iterator
\inmodule Qt3DCore
- \brief The Qt3D::QCircularBuffer::const_iterator class provides an STL-style const iterator for QCircularBuffer.
+ \brief The Qt3DCore::QCircularBuffer::const_iterator class provides an STL-style const iterator for QCircularBuffer.
QCircularBuffer provides both \l{STL-Style Iterators} and \l{Java-Style
Iterators}.
- \sa Qt3D::QCircularBuffer::constBegin(), Qt3D::QCircularBuffer::constEnd(),
- Qt3D::QCircularBuffer::iterator
+ \sa Qt3DCore::QCircularBuffer::constBegin(), Qt3DCore::QCircularBuffer::constEnd(),
+ Qt3DCore::QCircularBuffer::iterator
*/
-/*! \typedef Qt3D::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 Qt3D::QCircularBuffer::const_iterator::difference_type
+/*! \typedef Qt3DCore::QCircularBuffer::const_iterator::difference_type
\internal
*/
-/*! \typedef Qt3D::QCircularBuffer::const_iterator::value_type
+/*! \typedef Qt3DCore::QCircularBuffer::const_iterator::value_type
\internal
*/
-/*! \typedef Qt3D::QCircularBuffer::const_iterator::pointer
+/*! \typedef Qt3DCore::QCircularBuffer::const_iterator::pointer
\internal
*/
-/*! \typedef Qt3D::QCircularBuffer::const_iterator::reference
+/*! \typedef Qt3DCore::QCircularBuffer::const_iterator::reference
\internal
*/
-/*! \fn Qt3D::QCircularBuffer::const_iterator::const_iterator()
+/*! \fn Qt3DCore::QCircularBuffer::const_iterator::const_iterator()
Constructs an uninitialized const iterator.
@@ -1432,29 +1432,29 @@
on an uninitialized iterator. Use operator=() to assign a value
to it before using it.
- \sa Qt3D::QCircularBuffer::begin() Qt3D::QCircularBuffer::end()
+ \sa Qt3DCore::QCircularBuffer::begin() Qt3DCore::QCircularBuffer::end()
*/
-/*! \fn Qt3D::QCircularBuffer::const_iterator::const_iterator(const iterator &other)
+/*! \fn Qt3DCore::QCircularBuffer::const_iterator::const_iterator(const iterator &other)
\internal
*/
-/*! \fn const T &Qt3D::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 *Qt3D::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 &Qt3D::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}.
@@ -1466,7 +1466,7 @@
*/
/*!
- \fn bool Qt3D::QCircularBuffer::const_iterator::operator==(const const_iterator &other) const
+ \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator==(const const_iterator &other) const
Returns true if \a other points to the same item as this
iterator; otherwise returns false.
@@ -1475,7 +1475,7 @@
*/
/*!
- \fn bool Qt3D::QCircularBuffer::const_iterator::operator!=(const const_iterator &other) const
+ \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator!=(const const_iterator &other) const
Returns true if \a other points to a different item than this
iterator; otherwise returns false.
@@ -1484,45 +1484,45 @@
*/
/*!
- \fn bool Qt3D::QCircularBuffer::const_iterator::operator<(const const_iterator& other) const
+ \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator<(const const_iterator& other) const
Returns true if the item pointed to by this iterator occurs before
the item pointed to by the \a other iterator.
*/
/*!
- \fn bool Qt3D::QCircularBuffer::const_iterator::operator<=(const const_iterator& other) const
+ \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator<=(const const_iterator& other) const
Returns 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 Qt3D::QCircularBuffer::const_iterator::operator>(const const_iterator& other) const
+ \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator>(const const_iterator& other) const
Returns true if the item pointed to by this iterator occurs after
the item pointed to by the \a other iterator.
*/
/*!
- \fn bool Qt3D::QCircularBuffer::const_iterator::operator>=(const const_iterator& other) const
+ \fn bool Qt3DCore::QCircularBuffer::const_iterator::operator>=(const const_iterator& other) const
Returns 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 Qt3D::QCircularBuffer::const_iterator &Qt3D::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
item.
- Calling this function on Qt3D::QCircularBuffer::constEnd() leads to undefined results.
+ Calling this function on Qt3DCore::QCircularBuffer::constEnd() leads to undefined results.
\sa operator--()
*/
-/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::QCircularBuffer::const_iterator::operator++(int)
+/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::const_iterator::operator++(int)
\overload
@@ -1531,17 +1531,17 @@
current item.
*/
-/*! \fn Qt3D::QCircularBuffer::const_iterator &Qt3D::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.
- Calling this function on Qt3D::QCircularBuffer::constBegin() leads to undefined results.
+ Calling this function on Qt3DCore::QCircularBuffer::constBegin() leads to undefined results.
\sa operator++()
*/
-/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::QCircularBuffer::const_iterator::operator--(int)
+/*! \fn Qt3DCore::QCircularBuffer::const_iterator Qt3DCore::QCircularBuffer::const_iterator::operator--(int)
\overload
@@ -1549,7 +1549,7 @@
current and returns an iterator to the previously current item.
*/
-/*! \fn Qt3D::QCircularBuffer::const_iterator &Qt3D::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.)
@@ -1557,7 +1557,7 @@
\sa operator-=(), operator+()
*/
-/*! \fn Qt3D::QCircularBuffer::const_iterator &Qt3D::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.)
@@ -1565,7 +1565,7 @@
\sa operator+=(), operator-()
*/
-/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::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.)
@@ -1573,7 +1573,7 @@
\sa operator-(), operator+=()
*/
-/*! \fn Qt3D::QCircularBuffer::const_iterator Qt3D::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.)
@@ -1581,7 +1581,7 @@
\sa operator+(), operator-=()
*/
-/*! \fn int Qt3D::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.