From 4aeadb92130ce650bf5f137071d7777783eaa0e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomi=20Korpip=C3=A4=C3=A4?= Date: Tue, 19 Jan 2016 09:30:18 +0200 Subject: Fixed some documentation warnings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I5055043641a1916dde47ad614d8ab7a5788fd93b Task-number: QTBUG-46037 Reviewed-by: Miikka Heikkinen Reviewed-by: Pasi Keränen --- src/doc/src/qt3d-index.qdoc | 4 ++-- src/doc/src/qt3d-overview.qdoc | 4 ++-- src/doc/src/qt3drender-module.qdoc | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) (limited to 'src/doc/src') diff --git a/src/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc index 99a549b9b..4c2ce5a11 100644 --- a/src/doc/src/qt3d-index.qdoc +++ b/src/doc/src/qt3d-index.qdoc @@ -81,8 +81,8 @@ \section1 Overview The high level design and motivation for Qt3D is described in the \l {Qt 3D - Overview}. The Qt 3D Renderer aspect offers support for data-driven - configuration as described in \l {Qt 3D Renderer Framegraph}. + Overview}. The Qt 3D Render aspect offers support for data-driven + configuration as described in \l {Qt 3D Render Framegraph}. \section1 Reference \list diff --git a/src/doc/src/qt3d-overview.qdoc b/src/doc/src/qt3d-overview.qdoc index c77265ed9..331f508e6 100644 --- a/src/doc/src/qt3d-overview.qdoc +++ b/src/doc/src/qt3d-overview.qdoc @@ -157,7 +157,7 @@ and the fragment's depth can be compared with the result of the sampling. If the fragment is further away, then it is in shadow; otherwise it is lit. - For example code, see the \l {Qt3D: Shadow Map QML Example}. + For example code, see the \l {Qt 3D: Shadow Map QML Example}. \section2 Instanced Rendering @@ -183,7 +183,7 @@ To combine support for both C++ and QML APIs with having a fully configurable renderer, the concept of a \e framegraph was introduced. While a \e scenegraph is a data-driven description of \e what to render, a \l - {Qt 3D Renderer Framegraph}{framegraph} is a data-driven description of \e + {Qt 3D Render Framegraph}{framegraph} is a data-driven description of \e how to render it. A framegraph enables developers to choose between a simple forward renderer, diff --git a/src/doc/src/qt3drender-module.qdoc b/src/doc/src/qt3drender-module.qdoc index bae6217fd..7bab5cdf8 100644 --- a/src/doc/src/qt3drender-module.qdoc +++ b/src/doc/src/qt3drender-module.qdoc @@ -63,7 +63,7 @@ \section1 Overview The Qt 3D Render aspect offers support for data-driven configuration as described - in \l {Qt3D Render Framegraph}. + in \l {Qt 3D Render Framegraph}. \section1 Reference \list -- cgit v1.2.3 From 44c743c90cf51eddbf5b0bb3cf957c58fa0ef94f Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Tue, 19 Jan 2016 15:30:02 +0100 Subject: Doc: Removed Qt3DCollision namespace and module docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Besides that, fixed a few qdoc warnings. Change-Id: Ibaf8fd6ffbb93f3f2bd73fa5fedf06e94f6ac2eb Reviewed-by: Paul Lemire Reviewed-by: Topi Reiniö --- src/doc/src/qt3d-index.qdoc | 5 +-- src/doc/src/qt3d-module.qdoc | 7 ---- src/doc/src/qt3dcollision-module.qdoc | 74 ----------------------------------- 3 files changed, 2 insertions(+), 84 deletions(-) delete mode 100644 src/doc/src/qt3dcollision-module.qdoc (limited to 'src/doc/src') diff --git a/src/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc index 4c2ce5a11..9c4255ac8 100644 --- a/src/doc/src/qt3d-index.qdoc +++ b/src/doc/src/qt3d-index.qdoc @@ -58,7 +58,7 @@ \l qmake \c .pro file: \badcode - QT += 3dcore 3drender 3dinput 3dcollision 3dlogic + QT += 3dcore 3drender 3dinput 3dlogic \endcode To include the definitions of the modules' classes, use the following @@ -68,14 +68,13 @@ #include #include #include - #include #include \endcode A Qt Quick application requires also additional dependencies: \badcode - QT += 3dcore 3drenderer 3dinput 3dcollision qml quick 3dquick + QT += 3dcore 3drenderer 3dinput qml quick 3dquick \endcode \section1 Overview diff --git a/src/doc/src/qt3d-module.qdoc b/src/doc/src/qt3d-module.qdoc index 90bbd5e86..264c258c3 100644 --- a/src/doc/src/qt3d-module.qdoc +++ b/src/doc/src/qt3d-module.qdoc @@ -63,9 +63,6 @@ \section2 Qt 3D Core Module \generatelist {classesbymodule Qt3DCore} - \section2 Qt 3D Collision Module - \generatelist {classesbymodule Qt3DCollision} - \section2 Qt 3D Input Module \generatelist {classesbymodule Qt3DInput} @@ -104,7 +101,6 @@ following import statements: \badcode - import Qt3D.Collision 2.0 import Qt3D.Render 2.0 import Qt3D.Input 2.0 import Qt3D.Logic 2.0 @@ -115,9 +111,6 @@ \section2 Qt 3D Core Module \generatelist {qmltypesbymodule Qt3D.Core} - \section2 Qt 3D Collision Module - \generatelist {qmltypesbymodule Qt3D.Collision} - \section2 Qt 3D Input Module \generatelist {qmltypesbymodule Qt3D.Input} diff --git a/src/doc/src/qt3dcollision-module.qdoc b/src/doc/src/qt3dcollision-module.qdoc deleted file mode 100644 index 84ee787db..000000000 --- a/src/doc/src/qt3dcollision-module.qdoc +++ /dev/null @@ -1,74 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2015 The Qt Company Ltd. -** Contact: http://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see http://www.qt.io/terms-conditions. For further -** information use the contact form at http://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \module Qt3DCollision - \title Qt 3D Collision C++ Classes - \brief The Qt 3D Collision module enables collision detection. - \ingroup modules - \ingroup qt3d-modules - \qtvariable 3dcollision - - To use classes from this module, add this directive into the C++ files: - - \code - #include - \endcode - - To link against the corresponding C++ libraries, add the following to your qmake project file: - - \badcode - QT += 3dcollision - \endcode - -*/ - -/*! - \namespace Qt3DCollision - \inmodule Qt3DCollision - \ingroup qt3d-namespaces - - \brief Contains classes that enable collision detection. -*/ - -/*! - \qmlmodule Qt3D.Collision 2.0 - \title Qt 3D Collision QML Types - \ingroup qmlmodules - \ingroup qt3d-qmlmodules - - \brief Provides QML types to synchronize frames with the 3D backend. - - To import and use the module's QML types, use the following statement: - - \badcode - import Qt3D.Collision 2.0 - \endcode - - \section1 QML Types -*/ - -- cgit v1.2.3 From edcfa7aada9ff7edceb5808d3a7860256d4b91b7 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Fri, 22 Jan 2016 13:17:44 +0100 Subject: Doc: Use 'Qt 3D' instead of Qt3D consistently Change-Id: I91c0d00c0116a05209239da399f4076316a51fc7 Reviewed-by: Sean Harmer --- src/doc/src/qt3d-index.qdoc | 4 ++-- src/doc/src/qt3d-overview.qdoc | 8 ++++---- src/doc/src/qt3drender-module.qdoc | 5 +++-- 3 files changed, 9 insertions(+), 8 deletions(-) (limited to 'src/doc/src') diff --git a/src/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc index 9c4255ac8..e97f83c02 100644 --- a/src/doc/src/qt3d-index.qdoc +++ b/src/doc/src/qt3d-index.qdoc @@ -47,7 +47,7 @@ \annotatedlist qt3d-modules - For Qt Quick applications, Qt3D provides the following QML modules: + For Qt Quick applications, Qt 3D provides the following QML modules: \annotatedlist qt3d-qmlmodules @@ -79,7 +79,7 @@ \section1 Overview - The high level design and motivation for Qt3D is described in the \l {Qt 3D + The high level design and motivation for Qt 3D is described in the \l {Qt 3D Overview}. The Qt 3D Render aspect offers support for data-driven configuration as described in \l {Qt 3D Render Framegraph}. diff --git a/src/doc/src/qt3d-overview.qdoc b/src/doc/src/qt3d-overview.qdoc index 331f508e6..2e1dd053f 100644 --- a/src/doc/src/qt3d-overview.qdoc +++ b/src/doc/src/qt3d-overview.qdoc @@ -42,7 +42,7 @@ applications. Qt 3D provides a fully configurable renderer that enables developers to - quickly implement any rendering pipeline that they need. Further, Qt3D + quickly implement any rendering pipeline that they need. Further, Qt 3D provides a generic framework for near-realtime simulations beyond rendering. Qt 3D is cleanly separated into a core and any number of \e aspects that can @@ -163,7 +163,7 @@ \e Instancing is a way of getting the GPU to draw many copies (instances) of a base object that varies in some way for each copy. Often, in position, - orientation, color, material properties, scale, and so on. Qt3D provides an + orientation, color, material properties, scale, and so on. Qt 3D provides an API similar to the Qt Quick \l Repeater element. In this case, the delegate is the base object and the model provides the per-instance data. So whereas an entity with a \l Mesh component attached eventually gets transformed into @@ -196,7 +196,7 @@ \section1 3D Extensions - Beyond the essentials of displaying 3D content on the screen, Qt3D is + Beyond the essentials of displaying 3D content on the screen, Qt 3D is extensible and flexible enough to act as a host for following types of extensions related to the 3D objects: @@ -311,7 +311,7 @@ ignores it. Qt 3D builds custom entities by aggregating components that provide - additional capabilities. The Qt3D engine uses aspects to process and + additional capabilities. The Qt 3D engine uses aspects to process and update entities with specific components. For example, a physics aspect looks for entities that have some kind of diff --git a/src/doc/src/qt3drender-module.qdoc b/src/doc/src/qt3drender-module.qdoc index 7bab5cdf8..6cc53fe9d 100644 --- a/src/doc/src/qt3drender-module.qdoc +++ b/src/doc/src/qt3drender-module.qdoc @@ -37,14 +37,15 @@ /*! \module Qt3DRender \title Qt 3D Render C++ Classes - \brief The Qt 3D Render module contains functionality to support 2D and 3D rendering using Qt3D. + \brief The Qt 3D Render module contains functionality to support 2D and 3D + rendering using Qt 3D. \ingroup modules \ingroup qt3d-modules \qtvariable 3drender The Qt 3D Render module provides an aspect, components, and other supporting types necessary - to implement 2D and 3D rendering as part of the Qt3D framework. + to implement 2D and 3D rendering as part of the Qt 3D framework. To use classes from this module, add this directive into the C++ files: -- cgit v1.2.3 From c3e076082581e6fc4224655db26ec64de2fb76a9 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Fri, 22 Jan 2016 14:30:14 +0100 Subject: Doc: Mark QCircularBuffer as \internal As the class was made private, mark it \internal. Because its private header file is not included in the documentation build, also replace the qdoc comments '/*!' with standard C comments to avoid documentation warnings. Change-Id: I896d13e4192830976d8f24c5b98fdef2b127bf1c Reviewed-by: Sean Harmer --- src/doc/src/qcircularbuffer.qdoc | 318 +++++++++++++++++++-------------------- 1 file changed, 159 insertions(+), 159 deletions(-) (limited to 'src/doc/src') diff --git a/src/doc/src/qcircularbuffer.qdoc b/src/doc/src/qcircularbuffer.qdoc index 37fbda633..631087039 100644 --- a/src/doc/src/qcircularbuffer.qdoc +++ b/src/doc/src/qcircularbuffer.qdoc @@ -34,7 +34,7 @@ ** ****************************************************************************/ -/*! +/* !\internal \class Qt3DCore::QCircularBuffer \inmodule Qt3DCore \brief A template class providing a dynamic circular array. @@ -195,14 +195,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. @@ -210,7 +210,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. @@ -220,7 +220,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. @@ -230,7 +230,7 @@ \sa resize(), setCapacity(), fill() */ -/*! \fn Qt3DCore::QCircularBuffer::QCircularBuffer(const QCircularBuffer &other) +/* \fn Qt3DCore::QCircularBuffer::QCircularBuffer(const QCircularBuffer &other) Constructs a copy of \a other. @@ -242,18 +242,18 @@ \sa operator=() */ -/*! \fn Qt3DCore::QCircularBuffer::~QCircularBuffer() +/* \fn Qt3DCore::QCircularBuffer::~QCircularBuffer() Destroys the circular buffer. */ -/*! \fn QCircularBuffer &Qt3DCore::QCircularBuffer::operator=(const QCircularBuffer &other) +/* \fn QCircularBuffer &Qt3DCore::QCircularBuffer::operator=(const QCircularBuffer &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. @@ -261,12 +261,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. @@ -274,7 +274,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. @@ -282,12 +282,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. @@ -295,7 +295,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 @@ -304,7 +304,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 @@ -313,65 +313,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. @@ -385,7 +385,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. @@ -395,7 +395,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. @@ -408,14 +408,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. @@ -423,7 +423,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. @@ -431,7 +431,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. @@ -442,7 +442,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. @@ -452,14 +452,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 @@ -472,7 +472,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 @@ -481,7 +481,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. @@ -496,7 +496,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 @@ -512,7 +512,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 @@ -520,7 +520,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 @@ -536,7 +536,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 @@ -546,12 +546,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 @@ -561,7 +561,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. @@ -569,7 +569,7 @@ \sa isEmpty(), last(), startsWith() */ -/*! \fn QCircularBuffer& Qt3DCore::QCircularBuffer::fill(const T &value, int size = -1) +/* \fn QCircularBuffer& 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 @@ -583,7 +583,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. @@ -591,12 +591,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 @@ -605,7 +605,7 @@ \sa sizeAvailable(), capacity(), isEmpty(), isFull(), size() */ -/*! \fn static QCircularBuffer Qt3DCore::QCircularBuffer::fromList(const QList& list) +/* \fn static QCircularBuffer Qt3DCore::QCircularBuffer::fromList(const QList& 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 @@ -617,7 +617,7 @@ \sa fromVector(), toList(), toVector() */ -/*! \fn static QCircularBuffer Qt3DCore::QCircularBuffer::fromVector(const QVector& vector) +/* \fn static QCircularBuffer Qt3DCore::QCircularBuffer::fromVector(const QVector& 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 @@ -626,7 +626,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. @@ -641,7 +641,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 @@ -673,7 +673,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 @@ -707,7 +707,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 @@ -718,7 +718,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 @@ -728,21 +728,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. @@ -817,7 +817,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. @@ -825,12 +825,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 @@ -846,7 +846,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. @@ -856,7 +856,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. @@ -870,14 +870,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 @@ -887,7 +887,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. @@ -897,7 +897,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(). @@ -905,7 +905,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 @@ -916,21 +916,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 @@ -939,7 +939,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()). @@ -947,7 +947,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. @@ -955,7 +955,7 @@ \sa isEmpty(), first(), endsWith() */ -/*! \fn QList Qt3DCore::QCircularBuffer::toList() const +/* \fn QList Qt3DCore::QCircularBuffer::toList() const Returns a QList object with the data contained in this QCircularBuffer. @@ -966,14 +966,14 @@ \sa fromList(), toVector() */ -/*! \fn QVector Qt3DCore::QCircularBuffer::toVector() const +/* \fn QVector 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. @@ -985,7 +985,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 @@ -993,7 +993,7 @@ \a defaultValue. */ -/*! \fn bool Qt3DCore::operator==(const QCircularBuffer &lhs, const QCircularBuffer &rhs) +/* \fn bool Qt3DCore::operator==(const QCircularBuffer &lhs, const QCircularBuffer &rhs) Returns \c true if the circular buffer \a lhs is equal to \a rhs; otherwise returns \c false. @@ -1007,7 +1007,7 @@ \sa operator!=() */ -/*! \fn bool Qt3DCore::operator!=(const QCircularBuffer &lhs, const QCircularBuffer &rhs) +/* \fn bool Qt3DCore::operator!=(const QCircularBuffer &lhs, const QCircularBuffer &rhs) Returns \c true if the circular buffer \a lhs is not equal to \a rhs; otherwise returns \c false. @@ -1021,7 +1021,7 @@ \sa operator==() */ -/*! \fn Qt3DCore::QCircularBuffer& Qt3DCore::QCircularBuffer::operator+=(const T &other) +/* \fn Qt3DCore::QCircularBuffer& 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 Qt3DCore::QCircularBuffer& Qt3DCore::QCircularBuffer::operator+=(const QCircularBuffer& other) +/* \fn Qt3DCore::QCircularBuffer& Qt3DCore::QCircularBuffer::operator+=(const QCircularBuffer& other) \overload @@ -1039,17 +1039,17 @@ \sa operator+(), operator<<(), append() */ -/*! \fn Qt3DCore::QCircularBuffer& Qt3DCore::QCircularBuffer::operator+=(const QVector& other) +/* \fn Qt3DCore::QCircularBuffer& Qt3DCore::QCircularBuffer::operator+=(const QVector& other) \overload */ -/*! \fn Qt3DCore::QCircularBuffer& Qt3DCore::QCircularBuffer::operator+=(const QList& other) +/* \fn Qt3DCore::QCircularBuffer& Qt3DCore::QCircularBuffer::operator+=(const QList& other) \overload */ -/*! \fn Qt3DCore::QCircularBuffer& Qt3DCore::QCircularBuffer::operator<<(const T &other) +/* \fn Qt3DCore::QCircularBuffer& 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 Qt3DCore::QCircularBuffer& Qt3DCore::QCircularBuffer::operator<<(const QCircularBuffer& other) +/* \fn Qt3DCore::QCircularBuffer& Qt3DCore::QCircularBuffer::operator<<(const QCircularBuffer& other) \overload @@ -1067,17 +1067,17 @@ \sa operator+(), operator+=(), append() */ -/*! \fn Qt3DCore::QCircularBuffer& Qt3DCore::QCircularBuffer::operator<<(const QVector& other) +/* \fn Qt3DCore::QCircularBuffer& Qt3DCore::QCircularBuffer::operator<<(const QVector& other) \overload */ -/*! \fn Qt3DCore::QCircularBuffer& Qt3DCore::QCircularBuffer::operator<<(const QList& other) +/* \fn Qt3DCore::QCircularBuffer& Qt3DCore::QCircularBuffer::operator<<(const QList& other) \overload */ -/*! \fn Qt3DCore::QCircularBuffer Qt3DCore::operator+(const QCircularBuffer& lhs, const QCircularBuffer& rhs) +/* \fn Qt3DCore::QCircularBuffer Qt3DCore::operator+(const QCircularBuffer& lhs, const QCircularBuffer& rhs) \relates Qt3DCore::QCircularBuffer Returns a circular buffer object with capacity of lhs.size() + rhs.size() containing @@ -1086,78 +1086,78 @@ \sa {QCircularBuffer::}{operator+=()} */ -/*! \fn void Qt3DCore::swap(QCircularBuffer &lhs, QCircularBuffer &rhs) +/* \fn void Qt3DCore::swap(QCircularBuffer &lhs, QCircularBuffer &rhs) Swaps the contents of the circular buffer \a lhs with the contents of \a rhs. */ -/*! \fn bool Qt3DCore::operator<(const QCircularBuffer &lhs, const QCircularBuffer &rhs) +/* \fn bool Qt3DCore::operator<(const QCircularBuffer &lhs, const QCircularBuffer &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 &lhs, const QCircularBuffer &rhs) +/* \fn bool Qt3DCore::operator>(const QCircularBuffer &lhs, const QCircularBuffer &rhs) Returns \c true if \a rhs is lexographically less than \a lhs. */ -/*! \fn bool Qt3DCore::operator>=(const QCircularBuffer &lhs, const QCircularBuffer &rhs) +/* \fn bool Qt3DCore::operator>=(const QCircularBuffer &lhs, const QCircularBuffer &rhs) Returns \c true if \a lhs is lexographically less than or equal to \a rhs. */ -/*! \fn bool Qt3DCore::operator<=(const QCircularBuffer &lhs, const QCircularBuffer &rhs) +/* \fn bool Qt3DCore::operator<=(const QCircularBuffer &lhs, const QCircularBuffer &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. The first element is a pointer to the first element of an array of T. The second element is the number @@ -1166,25 +1166,25 @@ \sa data(), dataOne(), dataTwo() */ -/*! \typedef Qt3DCore::QCircularBuffer::const_array_range +/* \typedef Qt3DCore::QCircularBuffer::const_array_range Typedef for QPair. 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. @@ -1194,33 +1194,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. @@ -1231,12 +1231,12 @@ \sa begin(), end() */ -/*! \fn Qt3DCore::QCircularBuffer::iterator::iterator(QCircularBuffer *buffer, int index) +/* \fn Qt3DCore::QCircularBuffer::iterator::iterator(QCircularBuffer *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. @@ -1246,14 +1246,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}. @@ -1264,7 +1264,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 @@ -1273,7 +1273,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 @@ -1282,35 +1282,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 @@ -1321,7 +1321,7 @@ \sa operator--() */ -/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator++(int) +/* \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::QCircularBuffer::iterator::operator++(int) \overload @@ -1330,7 +1330,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. @@ -1340,7 +1340,7 @@ \sa operator++() */ -/*! \fn Qt3DCore::QCircularBuffer::iterator Qt3DCore::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 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.) @@ -1356,7 +1356,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.) @@ -1364,7 +1364,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.) @@ -1372,7 +1372,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.) @@ -1380,14 +1380,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. @@ -1397,33 +1397,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. @@ -1434,26 +1434,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}. @@ -1464,7 +1464,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 @@ -1473,7 +1473,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 @@ -1482,35 +1482,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 @@ -1521,7 +1521,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 @@ -1530,7 +1530,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. @@ -1540,7 +1540,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 @@ -1548,7 +1548,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.) @@ -1556,7 +1556,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.) @@ -1564,7 +1564,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.) @@ -1572,7 +1572,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.) @@ -1580,7 +1580,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. -- cgit v1.2.3