From 017569f702b6dd0bc3aa077d85e4a7fc27562133 Mon Sep 17 00:00:00 2001 From: Martin Smith Date: Thu, 25 Jan 2018 09:43:39 +0100 Subject: doc: Add missing \fn commands for new members MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit New members were added to QVarLengthArray and QVector, but the engineer didn't document them. Since they are only slightly different versions of existing functions, their \fn commands were added to the eisting qdoc comments. Some defined(Q_CLANG_QDOC) uses were also added. Change-Id: I8a5505ca27efc9205b1387ed0be310e4b74ec490 Reviewed-by: Topi Reiniö --- src/corelib/tools/qvarlengtharray.qdoc | 12 +++++++++--- src/corelib/tools/qvector.h | 8 ++++---- src/corelib/tools/qvector.qdoc | 16 ++++++++++++---- 3 files changed, 25 insertions(+), 11 deletions(-) (limited to 'src/corelib') diff --git a/src/corelib/tools/qvarlengtharray.qdoc b/src/corelib/tools/qvarlengtharray.qdoc index ef2fffa44c..aff2f986e6 100644 --- a/src/corelib/tools/qvarlengtharray.qdoc +++ b/src/corelib/tools/qvarlengtharray.qdoc @@ -516,7 +516,9 @@ Typedef for \c{std::reverse_iterator}. Provided for STL compatibility. */ -/*! \fn template void QVarLengthArray::prepend(const T &value) +/*! + \fn template void QVarLengthArray::prepend(const T &value) + \fn template void QVarLengthArray::prepend(T &&value) \since 4.8 Inserts \a value at the beginning of the array. @@ -696,7 +698,9 @@ before the call. */ -/*! \fn template void QVarLengthArray::insert(int i, const T &value) +/*! + \fn template void QVarLengthArray::insert(int i, const T &value) + \fn template void QVarLengthArray::insert(int i, T &&value) \since 4.8 Inserts \a value at index position \a i in the array. If \a i is @@ -721,7 +725,9 @@ vector. */ -/*! \fn template QVarLengthArray::iterator QVarLengthArray::insert(const_iterator before, const T &value) +/*! + \fn template QVarLengthArray::iterator QVarLengthArray::insert(const_iterator before, const T &value) + \fn template QVarLengthArray::iterator QVarLengthArray::insert(const_iterator before, T &&value) \overload \since 4.8 diff --git a/src/corelib/tools/qvector.h b/src/corelib/tools/qvector.h index 5ebf7f7435..24a19e68d4 100644 --- a/src/corelib/tools/qvector.h +++ b/src/corelib/tools/qvector.h @@ -72,7 +72,7 @@ public: inline QVector(const QVector &v); inline ~QVector() { if (!d->ref.deref()) freeData(d); } QVector &operator=(const QVector &v); -#ifdef Q_COMPILER_RVALUE_REFS +#if defined(Q_COMPILER_RVALUE_REFS) || defined(Q_CLANG_QDOC) QVector(QVector &&other) Q_DECL_NOTHROW : d(other.d) { other.d = Data::sharedNull(); } QVector &operator=(QVector &&other) Q_DECL_NOTHROW { QVector moved(std::move(other)); swap(moved); return *this; } @@ -133,7 +133,7 @@ public: T &operator[](int i); const T &operator[](int i) const; void append(const T &t); -#ifdef Q_COMPILER_RVALUE_REFS +#if defined(Q_COMPILER_RVALUE_REFS) || defined(Q_CLANG_QDOC) void append(T &&t); #endif inline void append(const QVector &l) { *this += l; } @@ -201,7 +201,7 @@ public: typedef typename Data::const_iterator const_iterator; typedef std::reverse_iterator reverse_iterator; typedef std::reverse_iterator const_reverse_iterator; -#if !defined(QT_STRICT_ITERATORS) || defined(Q_QDOC) +#if !defined(QT_STRICT_ITERATORS) || defined(Q_CLANG_QDOC) inline iterator begin() { detach(); return d->begin(); } inline const_iterator begin() const Q_DECL_NOTHROW { return d->constBegin(); } inline const_iterator cbegin() const Q_DECL_NOTHROW { return d->constBegin(); } @@ -258,7 +258,7 @@ public: typedef const_iterator ConstIterator; typedef int size_type; inline void push_back(const T &t) { append(t); } -#ifdef Q_COMPILER_RVALUE_REFS +#if defined(Q_COMPILER_RVALUE_REFS) || defined(Q_CLANG_QDOC) void push_back(T &&t) { append(std::move(t)); } void push_front(T &&t) { prepend(std::move(t)); } #endif diff --git a/src/corelib/tools/qvector.qdoc b/src/corelib/tools/qvector.qdoc index 089aaec3fd..173bdb5abf 100644 --- a/src/corelib/tools/qvector.qdoc +++ b/src/corelib/tools/qvector.qdoc @@ -587,7 +587,9 @@ */ -/*! \fn template void QVector::prepend(const T &value) +/*! + \fn template void QVector::prepend(const T &value) + \fn template void QVector::prepend(T &&value) Inserts \a value at the beginning of the vector. @@ -605,7 +607,9 @@ \sa append(), insert() */ -/*! \fn template void QVector::insert(int i, const T &value) +/*! + \fn template void QVector::insert(int i, const T &value) + \fn template void QVector::insert(int i, T &&value) Inserts \a value at index position \a i in the vector. If \a i is 0, the value is prepended to the vector. If \a i is size(), the @@ -634,7 +638,9 @@ \snippet code/src_corelib_tools_qvector.cpp 10 */ -/*! \fn template QVector::iterator QVector::insert(iterator before, const T &value) +/*! + \fn template QVector::iterator QVector::insert(iterator before, const T &value) + \fn template QVector::iterator QVector::insert(iterator before, T &&value) \overload @@ -1084,7 +1090,9 @@ \overload */ -/*! \fn template void QVector::push_front(const T &value) +/*! + \fn template void QVector::push_front(const T &value) + \fn template void QVector::push_front(T &&value) This function is provided for STL compatibility. It is equivalent to prepend(\a value). -- cgit v1.2.3