AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add template text to \fn commands in QVarLengthArray

Browse Source 
The \fn commands were not recognized by clang-qdoc because
the template stuff was missing from the \fn commands. This
update adds the correct template text and parameters. This
change eliminates about 150 qdoc warnings.

Change-Id: I23632e739b529cd56a6cae1a29df2e7131a05292
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
This commit is contained in:
Martin Smith 2017-09-14 13:57:05 +02:00
parent 7c7a95cd09
commit 6530b036c7
1 changed files with 75 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

150
src/corelib/tools/qvarlengtharray.qdoc
View File

@ -90,7 +90,7 @@
\sa QVector, QList, QLinkedList
*/
/*! \fn QVarLengthArray::QVarLengthArray(int size)
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::QVarLengthArray(int size)
Constructs an array with an initial size of \a size elements.
@ -101,7 +101,7 @@
*/
/*! \fn QVarLengthArray::QVarLengthArray(std::initializer_list<T> args)
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::QVarLengthArray(std::initializer_list<T> args)
\since 5.5
Constructs an array from the std::initializer_list given by \a args.
@ -111,26 +111,26 @@
*/
/*! \fn QVarLengthArray::~QVarLengthArray()
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::~QVarLengthArray()
Destroys the array.
*/
/*! \fn int QVarLengthArray::size() const
/*! \fn template<class T, int Prealloc> int QVarLengthArray<T, Prealloc>::size() const
Returns the number of elements in the array.
\sa isEmpty(), resize()
*/
/*! \fn int QVarLengthArray::count() const
/*! \fn template<class T, int Prealloc> int QVarLengthArray<T, Prealloc>::count() const
Same as size().
\sa isEmpty(), resize()
*/
/*! \fn int QVarLengthArray::length() const
/*! \fn template<class T, int Prealloc> int QVarLengthArray<T, Prealloc>::length() const
\since 5.0
Same as size().
@ -138,7 +138,7 @@
\sa isEmpty(), resize()
*/
/*! \fn T& QVarLengthArray::first()
/*! \fn template<class T, int Prealloc> T& QVarLengthArray<T, Prealloc>::first()
Returns a reference to the first item in the array. The array must
not be empty. If the array can be empty, check isEmpty() before
@ -147,24 +147,24 @@
\sa last(), isEmpty()
*/
/*! \fn const T& QVarLengthArray::first() const
/*! \fn template<class T, int Prealloc> const T& QVarLengthArray<T, Prealloc>::first() const
\overload
*/
/*! \fn T& QVarLengthArray::front()
/*! \fn template<class T, int Prealloc> T& QVarLengthArray<T, Prealloc>::front()
\since 5.0
Same as first(). Provided for STL-compatibility.
*/
/*! \fn const T& QVarLengthArray::front() const
/*! \fn template<class T, int Prealloc> const T& QVarLengthArray<T, Prealloc>::front() const
\since 5.0
\overload
*/
/*! \fn T& QVarLengthArray::last()
/*! \fn template<class T, int Prealloc> T& QVarLengthArray<T, Prealloc>::last()
Returns a reference to the last item in the array. The array must
not be empty. If the array can be empty, check isEmpty() before
@ -173,37 +173,37 @@
\sa first(), isEmpty()
*/
/*! \fn const T& QVarLengthArray::last() const
/*! \fn template<class T, int Prealloc> const T& QVarLengthArray<T, Prealloc>::last() const
\overload
*/
/*! \fn T& QVarLengthArray::back()
/*! \fn template<class T, int Prealloc> T& QVarLengthArray<T, Prealloc>::back()
\since 5.0
Same as last(). Provided for STL-compatibility.
*/
/*! \fn const T& QVarLengthArray::back() const
/*! \fn template<class T, int Prealloc> const T& QVarLengthArray<T, Prealloc>::back() const
\since 5.0
\overload
*/
/*! \fn void QVarLengthArray::shrink_to_fit()
/*! \fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::shrink_to_fit()
\since 5.10
Same as squeeze(). Provided for STL-compatibility.
*/
/*! \fn bool QVarLengthArray::isEmpty() const
/*! \fn template<class T, int Prealloc> bool QVarLengthArray<T, Prealloc>::isEmpty() const
Returns \c true if the array has size 0; otherwise returns \c false.
\sa size(), resize()
*/
/*! \fn bool QVarLengthArray::empty() const
/*! \fn template<class T, int Prealloc> bool QVarLengthArray<T, Prealloc>::empty() const
\since 5.0
Returns \c true if the array has size 0; otherwise returns \c false.
@ -211,14 +211,14 @@
Same as isEmpty(). Provided for STL-compatibility.
*/
/*! \fn void QVarLengthArray::clear()
/*! \fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::clear()
Removes all the elements from the array.
Same as resize(0).
*/
/*! \fn void QVarLengthArray::resize(int size)
/*! \fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::resize(int size)
Sets the size of the array to \a size. If \a size is greater than
the current size, elements are added to the end. If \a size is
@ -232,7 +232,7 @@
\sa size(), squeeze()
*/
/*! \fn int QVarLengthArray::capacity() const
/*! \fn template<class T, int Prealloc> int QVarLengthArray<T, Prealloc>::capacity() const
Returns the maximum number of elements that can be stored in the
array without forcing a reallocation.
@ -245,7 +245,7 @@
\sa reserve(), squeeze()
*/
/*! \fn void QVarLengthArray::reserve(int size)
/*! \fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::reserve(int size)
Attempts to allocate memory for at least \a size elements. If you
know in advance how large the array can get, you can call this
@ -262,7 +262,7 @@
\sa capacity(), squeeze()
*/
/*! \fn void QVarLengthArray::squeeze()
/*! \fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::squeeze()
\since 5.1
Releases any memory not required to store the items.
@ -276,7 +276,7 @@
\sa reserve(), capacity(), resize()
*/
/*! \fn T &QVarLengthArray::operator[](int i)
/*! \fn template<class T, int Prealloc> T &QVarLengthArray<T, Prealloc>::operator[](int i)
Returns a reference to the item at index position \a i.
@ -286,14 +286,14 @@
\sa data(), at()
*/
/*! \fn const T &QVarLengthArray::operator[](int i) const
/*! \fn template<class T, int Prealloc> const T &QVarLengthArray<T, Prealloc>::operator[](int i) const
\overload
*/
/*!
\fn void QVarLengthArray::append(const T &t)
\fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::append(const T &t)
Appends item \a t to the array, extending the array if necessary.
@ -301,7 +301,7 @@
*/
/*!
\fn void QVarLengthArray::push_back(const T &t)
\fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::push_back(const T &t)
\since 5.0
Appends item \a t to the array, extending the array if necessary.
@ -309,7 +309,7 @@
*/
/*!
\fn void QVarLengthArray::append(T &&t)
\fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::append(T &&t)
\overload append
\since 5.9
@ -323,7 +323,7 @@
*/
/*!
\fn void QVarLengthArray::push_back(T &&t)
\fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::push_back(T &&t)
\overload push_back
\since 5.9
@ -337,7 +337,7 @@
*/
/*!
\fn inline void QVarLengthArray::removeLast()
\fn template<class T, int Prealloc> inline void QVarLengthArray<T, Prealloc>::removeLast()
\since 4.5
Decreases the size of the array by one. The allocated size is not changed.
@ -346,20 +346,20 @@
*/
/*!
\fn void QVarLengthArray::pop_back()
\fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::pop_back()
\since 5.0
Same as removeLast(). Provided for STL-compatibility.
*/
/*!
\fn void QVarLengthArray::append(const T *buf, int size)
\fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::append(const T *buf, int size)
Appends \a size amount of items referenced by \a buf to this array.
*/
/*! \fn T *QVarLengthArray::data()
/*! \fn template<class T, int Prealloc> T *QVarLengthArray<T, Prealloc>::data()
Returns a pointer to the data stored in the array. The pointer can
be used to access and modify the items in the array.
@ -375,12 +375,12 @@
\sa constData(), operator[]()
*/
/*! \fn const T *QVarLengthArray::data() const
/*! \fn template<class T, int Prealloc> const T *QVarLengthArray<T, Prealloc>::data() const
\overload
*/
/*! \fn const T *QVarLengthArray::constData() const
/*! \fn template<class T, int Prealloc> const T *QVarLengthArray<T, Prealloc>::constData() const
Returns a const pointer to the data stored in the array. The
pointer can be used to access the items in the array. The
@ -392,11 +392,11 @@
\sa data(), operator[]()
*/
/*! \fn QVarLengthArray<T, Prealloc> &QVarLengthArray::operator=(const QVarLengthArray<T, Prealloc> &other)
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc> &QVarLengthArray<T, Prealloc>::operator=(const QVarLengthArray<T, Prealloc> &other)
Assigns \a other to this array and returns a reference to this array.
*/
/*! \fn QVarLengthArray<T, Prealloc> &QVarLengthArray::operator=(std::initializer_list<T> list)
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc> &QVarLengthArray<T, Prealloc>::operator=(std::initializer_list<T> list)
\since 5.5
Assigns the values of \a list to this array, and returns a reference to this array.
@ -405,11 +405,11 @@
lists.
*/
/*! \fn QVarLengthArray::QVarLengthArray(const QVarLengthArray<T, Prealloc> &other)
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::QVarLengthArray(const QVarLengthArray<T, Prealloc> &other)
Constructs a copy of \a other.
*/
/*! \fn const T &QVarLengthArray::at(int i) const
/*! \fn template<class T, int Prealloc> const T &QVarLengthArray<T, Prealloc>::at(int i) const
Returns a reference to the item at index position \a i.
@ -419,7 +419,7 @@
\sa value(), operator[]()
*/
/*! \fn T QVarLengthArray::value(int i) const
/*! \fn template<class T, int Prealloc> T QVarLengthArray<T, Prealloc>::value(int i) const
Returns the value at index position \a i.
@ -431,7 +431,7 @@
\sa at(), operator[]()
*/
/*! \fn T QVarLengthArray::value(int i, const T &defaultValue) const
/*! \fn template<class T, int Prealloc> T QVarLengthArray<T, Prealloc>::value(int i, const T &defaultValue) const
\overload
@ -516,7 +516,7 @@
Typedef for \c{std::reverse_iterator<T*>}. Provided for STL compatibility.
*/
/*! \fn void QVarLengthArray::prepend(const T &value)
/*! \fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::prepend(const T &value)
\since 4.8
Inserts \a value at the beginning of the array.
@ -533,7 +533,7 @@
\sa append(), insert()
*/
/*! \fn void QVarLengthArray::replace(int i, const T &value)
/*! \fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::replace(int i, const T &value)
\since 4.8
Replaces the item at index position \a i with \a value.
@ -544,7 +544,7 @@
\sa operator[](), remove()
*/
/*! \fn void QVarLengthArray::remove(int i)
/*! \fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::remove(int i)
\overload
\since 4.8
@ -554,7 +554,7 @@
\sa insert(), replace()
*/
/*! \fn void QVarLengthArray::remove(int i, int count)
/*! \fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::remove(int i, int count)
\overload
\since 4.8
@ -565,7 +565,7 @@
\sa insert(), replace()
*/
/*! \fn QVarLengthArray::iterator QVarLengthArray::begin()
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::iterator QVarLengthArray<T, Prealloc>::begin()
\since 4.8
Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first item in
@ -574,12 +574,12 @@
\sa constBegin(), end()
*/
/*! \fn QVarLengthArray::const_iterator QVarLengthArray::begin() const
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::const_iterator QVarLengthArray<T, Prealloc>::begin() const
\since 4.8
\overload
*/
/*! \fn QVarLengthArray::const_iterator QVarLengthArray::cbegin() const
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::const_iterator QVarLengthArray<T, Prealloc>::cbegin() const
\since 5.0
Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
@ -588,7 +588,7 @@
\sa begin(), cend()
*/
/*! \fn QVarLengthArray::const_iterator QVarLengthArray::constBegin() const
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::const_iterator QVarLengthArray<T, Prealloc>::constBegin() const
\since 4.8
Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
@ -597,7 +597,7 @@
\sa begin(), constEnd()
*/
/*! \fn QVarLengthArray::iterator QVarLengthArray::end()
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::iterator QVarLengthArray<T, Prealloc>::end()
\since 4.8
Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item
@ -606,13 +606,13 @@
\sa begin(), constEnd()
*/
/*! \fn QVarLengthArray::const_iterator QVarLengthArray::end() const
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::const_iterator QVarLengthArray<T, Prealloc>::end() const
\since 4.8
\overload
*/
/*! \fn QVarLengthArray::const_iterator QVarLengthArray::cend() const
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::const_iterator QVarLengthArray<T, Prealloc>::cend() const
\since 5.0
Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
@ -621,7 +621,7 @@
\sa cbegin(), end()
*/
/*! \fn QVarLengthArray::const_iterator QVarLengthArray::constEnd() const
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::const_iterator QVarLengthArray<T, Prealloc>::constEnd() const
\since 4.8
Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
@ -630,7 +630,7 @@
\sa constBegin(), end()
*/
/*! \fn QVarLengthArray::reverse_iterator QVarLengthArray::rbegin()
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::reverse_iterator QVarLengthArray<T, Prealloc>::rbegin()
\since 5.6
Returns a \l{STL-style iterators}{STL-style} reverse iterator pointing to the first
@ -639,12 +639,12 @@
\sa begin(), crbegin(), rend()
*/
/*! \fn QVarLengthArray::const_reverse_iterator QVarLengthArray::rbegin() const
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::const_reverse_iterator QVarLengthArray<T, Prealloc>::rbegin() const
\since 5.6
\overload
*/
/*! \fn QVarLengthArray::const_reverse_iterator QVarLengthArray::crbegin() const
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::const_reverse_iterator QVarLengthArray<T, Prealloc>::crbegin() const
\since 5.6
Returns a const \l{STL-style iterators}{STL-style} reverse iterator pointing to the first
@ -653,7 +653,7 @@
\sa begin(), rbegin(), rend()
*/
/*! \fn QVarLengthArray::reverse_iterator QVarLengthArray::rend()
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::reverse_iterator QVarLengthArray<T, Prealloc>::rend()
\since 5.6
Returns a \l{STL-style iterators}{STL-style} reverse iterator pointing to one past
@ -662,12 +662,12 @@
\sa end(), crend(), rbegin()
*/
/*! \fn QVarLengthArray::const_reverse_iterator QVarLengthArray::rend() const
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::const_reverse_iterator QVarLengthArray<T, Prealloc>::rend() const
\since 5.6
\overload
*/
/*! \fn QVarLengthArray::const_reverse_iterator QVarLengthArray::crend() const
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::const_reverse_iterator QVarLengthArray<T, Prealloc>::crend() const
\since 5.6
Returns a const \l{STL-style iterators}{STL-style} reverse iterator pointing to one
@ -676,7 +676,7 @@
\sa end(), rend(), rbegin()
*/
/*! \fn QVarLengthArray::iterator QVarLengthArray::erase(const_iterator pos)
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::iterator QVarLengthArray<T, Prealloc>::erase(const_iterator pos)
\since 4.8
Removes the item pointed to by the iterator \a pos from the
@ -686,7 +686,7 @@
\sa insert(), remove()
*/
/*! \fn QVarLengthArray::iterator QVarLengthArray::erase(const_iterator begin, const_iterator end)
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::iterator QVarLengthArray<T, Prealloc>::erase(const_iterator begin, const_iterator end)
\overload
\since 4.8
@ -696,7 +696,7 @@
before the call.
*/
/*! \fn void QVarLengthArray::insert(int i, const T &value)
/*! \fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::insert(int i, const T &value)
\since 4.8
Inserts \a value at index position \a i in the array. If \a i is
@ -712,7 +712,7 @@
\sa remove()
*/
/*! \fn void QVarLengthArray::insert(int i, int count, const T &value)
/*! \fn template<class T, int Prealloc> void QVarLengthArray<T, Prealloc>::insert(int i, int count, const T &value)
\overload
\since 4.8
@ -721,7 +721,7 @@
vector.
*/
/*! \fn QVarLengthArray::iterator QVarLengthArray::insert(const_iterator before, const T &value)
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::iterator QVarLengthArray<T, Prealloc>::insert(const_iterator before, const T &value)
\overload
\since 4.8
@ -730,7 +730,7 @@
\a before. Returns an iterator pointing at the inserted item.
*/
/*! \fn QVarLengthArray::iterator QVarLengthArray::insert(const_iterator before, int count, const T &value)
/*! \fn template<class T, int Prealloc> QVarLengthArray<T, Prealloc>::iterator QVarLengthArray<T, Prealloc>::insert(const_iterator before, int count, const T &value)
\since 4.8
Inserts \a count copies of \a value in front of the item pointed to
@ -740,7 +740,7 @@
/*! \fn bool operator==(const QVarLengthArray<T, Prealloc1> &left, const QVarLengthArray<T, Prealloc2> &right)
/*! \fn template<class T, int Prealloc1, int Prealloc2> bool operator==(const QVarLengthArray<T, Prealloc1> &left, const QVarLengthArray<T, Prealloc2> &right)
\relates QVarLengthArray
\since 4.8
@ -755,7 +755,7 @@
\sa operator!=()
*/
/*! \fn bool operator!=(const QVarLengthArray<T, Prealloc1> &left, const QVarLengthArray<T, Prealloc2> &right)
/*! \fn template<typename T, int Prealloc1, int Prealloc2> bool operator!=(const QVarLengthArray<T, Prealloc1> &left, const QVarLengthArray<T, Prealloc2> &right)
\relates QVarLengthArray
\since 4.8
@ -770,7 +770,7 @@
\sa operator==()
*/
/*! \fn bool operator<(const QVarLengthArray<T,Prealloc1> &lhs, const QVarLengthArray<T,Prealloc2> &rhs)
/*! \fn template<typename T, int Prealloc1, int Prealloc2> bool operator<(const QVarLengthArray<T,Prealloc1> &lhs, const QVarLengthArray<T,Prealloc2> &rhs)
\since 5.6
\relates QVarLengthArray
@ -782,7 +782,7 @@
of \c operator<().
*/
/*! \fn bool operator<=(const QVarLengthArray<T,Prealloc1> &lhs, const QVarLengthArray<T,Prealloc2> &rhs)
/*! \fn template<typename T, int Prealloc1, int Prealloc2> bool operator<=(const QVarLengthArray<T,Prealloc1> &lhs, const QVarLengthArray<T,Prealloc2> &rhs)
\since 5.6
\relates QVarLengthArray
@ -794,7 +794,7 @@
of \c operator<().
*/
/*! \fn bool operator>(const QVarLengthArray<T,Prealloc1> &lhs, const QVarLengthArray<T,Prealloc2> &rhs)
/*! \fn template<typename T, int Prealloc1, int Prealloc2> bool operator>(const QVarLengthArray<T,Prealloc1> &lhs, const QVarLengthArray<T,Prealloc2> &rhs)
\since 5.6
\relates QVarLengthArray
@ -806,7 +806,7 @@
of \c operator<().
*/
/*! \fn bool operator>=(const QVarLengthArray<T,Prealloc1> &lhs, const QVarLengthArray<T,Prealloc2> &rhs)
/*! \fn template<typename T, int Prealloc1, int Prealloc2> bool operator>=(const QVarLengthArray<T,Prealloc1> &lhs, const QVarLengthArray<T,Prealloc2> &rhs)
\since 5.6
\relates QVarLengthArray
@ -818,7 +818,7 @@
of \c operator<().
*/
/*! \fn QVarLengthArray &QVarLengthArray::operator<<(const T &value)
/*! \fn template<class T, int Prealloc> QVarLengthArray &QVarLengthArray<T, Prealloc>::operator<<(const T &value)
\since 4.8
Appends \a value to the array and returns a reference to this
@ -827,7 +827,7 @@
\sa append(), operator+=()
*/
/*! \fn QVarLengthArray &QVarLengthArray::operator+=(const T &value)
/*! \fn template<class T, int Prealloc> QVarLengthArray &QVarLengthArray<T, Prealloc>::operator+=(const T &value)
\since 4.8
Appends \a value to the array and returns a reference to this vector.
@ -835,7 +835,7 @@
\sa append(), operator<<()
*/
/*! \fn int QVarLengthArray::indexOf(const T &value, int from = 0) const
/*! \fn template<class T, int Prealloc> int QVarLengthArray<T, Prealloc>::indexOf(const T &value, int from = 0) const
\since 5.3
Returns the index position of the first occurrence of \a value in
@ -848,7 +848,7 @@
\sa lastIndexOf(), contains()
*/
/*! \fn int QVarLengthArray::lastIndexOf(const T &value, int from = -1) const
/*! \fn template<class T, int Prealloc> int QVarLengthArray<T, Prealloc>::lastIndexOf(const T &value, int from = -1) const
\since 5.3
Returns the index position of the last occurrence of the value \a
@ -862,7 +862,7 @@
\sa indexOf(), contains()
*/
/*! \fn bool QVarLengthArray::contains(const T &value) const
/*! \fn template<class T, int Prealloc> bool QVarLengthArray<T, Prealloc>::contains(const T &value) const
\since 5.3
Returns \c true if the array contains an occurrence of \a value;