From b23c52ea8110f05def21713934fcc6131f44ec6a Mon Sep 17 00:00:00 2001 From: Martin Smith Date: Wed, 13 Sep 2017 12:07:28 +0200 Subject: Add template text to \fn commands in container classes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. It eliminates nearly 2000 qdoc warnings. Change-Id: Ibe047424396a8f99f8bd64efea1b0d8cc7c7527d Reviewed-by: Topi Reiniƶ --- src/corelib/tools/qset.qdoc | 196 ++++++++++++++++++++++---------------------- 1 file changed, 98 insertions(+), 98 deletions(-) (limited to 'src/corelib/tools/qset.qdoc') diff --git a/src/corelib/tools/qset.qdoc b/src/corelib/tools/qset.qdoc index 93f157fdc5..48863f2399 100644 --- a/src/corelib/tools/qset.qdoc +++ b/src/corelib/tools/qset.qdoc @@ -96,14 +96,14 @@ */ /*! - \fn QSet::QSet() + \fn template QSet::QSet() Constructs an empty set. \sa clear() */ -/*! \fn QSet::QSet(std::initializer_list list) +/*! \fn template QSet::QSet(std::initializer_list list) \since 5.1 Constructs a set with a copy of each of the elements in the @@ -114,14 +114,14 @@ */ /*! - \fn void QSet::swap(QSet &other) + \fn template void QSet::swap(QSet &other) Swaps set \a other with this set. This operation is very fast and never fails. */ /*! - \fn bool QSet::operator==(const QSet &other) const + \fn template bool QSet::operator==(const QSet &other) const Returns \c true if the \a other set is equal to this set; otherwise returns \c false. @@ -134,7 +134,7 @@ */ /*! - \fn bool QSet::operator!=(const QSet &other) const + \fn template bool QSet::operator!=(const QSet &other) const Returns \c true if the \a other set is not equal to this set; otherwise returns \c false. @@ -147,7 +147,7 @@ */ /*! - \fn int QSet::size() const + \fn template int QSet::size() const Returns the number of items in the set. @@ -155,7 +155,7 @@ */ /*! - \fn bool QSet::isEmpty() const + \fn template bool QSet::isEmpty() const Returns \c true if the set contains no elements; otherwise returns false. @@ -164,7 +164,7 @@ */ /*! - \fn int QSet::capacity() const + \fn template int QSet::capacity() const Returns the number of buckets in the set's internal hash table. @@ -177,7 +177,7 @@ \sa reserve(), squeeze() */ -/*! \fn void QSet::reserve(int size) +/*! \fn template void QSet::reserve(int size) Ensures that the set's internal hash table consists of at least \a size buckets. @@ -201,7 +201,7 @@ */ /*! - \fn void QSet::squeeze() + \fn template void QSet::squeeze() Reduces the size of the set's internal hash table to save memory. @@ -214,7 +214,7 @@ */ /*! - \fn void QSet::detach() + \fn template void QSet::detach() \internal @@ -224,7 +224,7 @@ \sa isDetached() */ -/*! \fn bool QSet::isDetached() const +/*! \fn template bool QSet::isDetached() const \internal @@ -235,12 +235,12 @@ */ /*! - \fn void QSet::setSharable(bool sharable) + \fn template void QSet::setSharable(bool sharable) \internal */ /*! - \fn void QSet::clear() + \fn template void QSet::clear() Removes all elements from the set. @@ -248,7 +248,7 @@ */ /*! - \fn bool QSet::remove(const T &value) + \fn template bool QSet::remove(const T &value) Removes any occurrence of item \a value from the set. Returns true if an item was actually removed; otherwise returns \c false. @@ -257,7 +257,7 @@ */ /*! - \fn QSet::iterator QSet::erase(const_iterator pos) + \fn template QSet::iterator QSet::erase(const_iterator pos) \since 5.7 Removes the item at the iterator position \a pos from the set, and @@ -271,12 +271,12 @@ */ /*! - \fn QSet::iterator QSet::erase(iterator pos) + \fn template QSet::iterator QSet::erase(iterator pos) \since 4.2 \overload */ -/*! \fn QSet::const_iterator QSet::find(const T &value) const +/*! \fn template QSet::const_iterator QSet::find(const T &value) const \since 4.2 Returns a const iterator positioned at the item \a value in the @@ -286,7 +286,7 @@ \sa constFind(), contains() */ -/*! \fn QSet::iterator QSet::find(const T &value) +/*! \fn template QSet::iterator QSet::find(const T &value) \since 4.2 \overload @@ -295,7 +295,7 @@ returns end(). */ -/*! \fn QSet::const_iterator QSet::constFind(const T &value) const +/*! \fn template QSet::const_iterator QSet::constFind(const T &value) const \since 4.2 Returns a const iterator positioned at the item \a value in the @@ -306,7 +306,7 @@ */ /*! - \fn bool QSet::contains(const T &value) const + \fn template bool QSet::contains(const T &value) const Returns \c true if the set contains item \a value; otherwise returns false. @@ -315,7 +315,7 @@ */ /*! - \fn bool QSet::contains(const QSet &other) const + \fn template bool QSet::contains(const QSet &other) const \since 4.6 Returns \c true if the set contains all items from the \a other set; @@ -324,7 +324,7 @@ \sa insert(), remove(), find() */ -/*! \fn QSet::const_iterator QSet::begin() const +/*! \fn template QSet::const_iterator QSet::begin() const Returns a const \l{STL-style iterators}{STL-style iterator} positioned at the first item in the set. @@ -332,7 +332,7 @@ \sa constBegin(), end() */ -/*! \fn QSet::iterator QSet::begin() +/*! \fn template QSet::iterator QSet::begin() \since 4.2 \overload @@ -340,7 +340,7 @@ item in the set. */ -/*! \fn QSet::const_iterator QSet::cbegin() const +/*! \fn template QSet::const_iterator QSet::cbegin() const \since 5.0 Returns a const \l{STL-style iterators}{STL-style iterator} positioned at the first @@ -349,7 +349,7 @@ \sa begin(), cend() */ -/*! \fn QSet::const_iterator QSet::constBegin() const +/*! \fn template QSet::const_iterator QSet::constBegin() const Returns a const \l{STL-style iterators}{STL-style iterator} positioned at the first item in the set. @@ -357,7 +357,7 @@ \sa begin(), constEnd() */ -/*! \fn QSet::const_iterator QSet::end() const +/*! \fn template QSet::const_iterator QSet::end() const Returns a const \l{STL-style iterators}{STL-style iterator} positioned at the imaginary item after the last item in the set. @@ -365,7 +365,7 @@ \sa constEnd(), begin() */ -/*! \fn QSet::iterator QSet::end() +/*! \fn template QSet::iterator QSet::end() \since 4.2 \overload @@ -373,7 +373,7 @@ imaginary item after the last item in the set. */ -/*! \fn QSet::const_iterator QSet::cend() const +/*! \fn template QSet::const_iterator QSet::cend() const \since 5.0 Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary @@ -382,7 +382,7 @@ \sa cbegin(), end() */ -/*! \fn QSet::const_iterator QSet::constEnd() const +/*! \fn template QSet::const_iterator QSet::constEnd() const Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item after the last item in the set. @@ -390,7 +390,7 @@ \sa constBegin(), end() */ -/*! \fn QSet::reverse_iterator QSet::rbegin() +/*! \fn template QSet::reverse_iterator QSet::rbegin() \since 5.6 Returns a \l{STL-style iterators}{STL-style} reverse iterator pointing to the first @@ -399,12 +399,12 @@ \sa begin(), crbegin(), rend() */ -/*! \fn QSet::const_reverse_iterator QSet::rbegin() const +/*! \fn template QSet::const_reverse_iterator QSet::rbegin() const \since 5.6 \overload */ -/*! \fn QSet::const_reverse_iterator QSet::crbegin() const +/*! \fn template QSet::const_reverse_iterator QSet::crbegin() const \since 5.6 Returns a const \l{STL-style iterators}{STL-style} reverse iterator pointing to the first @@ -413,7 +413,7 @@ \sa begin(), rbegin(), rend() */ -/*! \fn QSet::reverse_iterator QSet::rend() +/*! \fn template QSet::reverse_iterator QSet::rend() \since 5.6 Returns a \l{STL-style iterators}{STL-style} reverse iterator pointing to one past @@ -422,12 +422,12 @@ \sa end(), crend(), rbegin() */ -/*! \fn QSet::const_reverse_iterator QSet::rend() const +/*! \fn template QSet::const_reverse_iterator QSet::rend() const \since 5.6 \overload */ -/*! \fn QSet::const_reverse_iterator QSet::crend() const +/*! \fn template QSet::const_reverse_iterator QSet::crend() const \since 5.6 Returns a const \l{STL-style iterators}{STL-style} reverse iterator pointing to one @@ -530,7 +530,7 @@ */ /*! - \fn QSet::insert(const T &value) + \fn template QSet::insert(const T &value) Inserts item \a value into the set, if \a value isn't already in the set, and returns an iterator pointing at the inserted @@ -540,7 +540,7 @@ */ /*! - \fn QSet &QSet::unite(const QSet &other) + \fn template QSet &QSet::unite(const QSet &other) Each item in the \a other set that isn't already in this set is inserted into this set. A reference to this set is returned. @@ -549,7 +549,7 @@ */ /*! - \fn QSet &QSet::intersect(const QSet &other) + \fn template QSet &QSet::intersect(const QSet &other) Removes all items from this set that are not contained in the \a other set. A reference to this set is returned. @@ -558,7 +558,7 @@ */ /*! - \fn bool QSet::intersects(const QSet &other) const + \fn template bool QSet::intersects(const QSet &other) const \since 5.6 Returns \c true if this set has at least one item in common with @@ -568,7 +568,7 @@ */ /*! - \fn QSet &QSet::subtract(const QSet &other) + \fn template QSet &QSet::subtract(const QSet &other) Removes all items from this set that are contained in the \a other set. Returns a reference to this set. @@ -577,22 +577,22 @@ */ /*! - \fn bool QSet::empty() const + \fn template bool QSet::empty() const Returns \c true if the set is empty. This function is provided for STL compatibility. It is equivalent to isEmpty(). */ /*! - \fn bool QSet::count() const + \fn template bool QSet::count() const Same as size(). */ /*! - \fn QSet &QSet::operator<<(const T &value) - \fn QSet &QSet::operator+=(const T &value) - \fn QSet &QSet::operator|=(const T &value) + \fn template QSet &QSet::operator<<(const T &value) + \fn template QSet &QSet::operator+=(const T &value) + \fn template QSet &QSet::operator|=(const T &value) Inserts a new item \a value and returns a reference to the set. If \a value already exists in the set, the set is left unchanged. @@ -601,7 +601,7 @@ */ /*! - \fn QSet &QSet::operator-=(const T &value) + \fn template QSet &QSet::operator-=(const T &value) Removes the occurrence of item \a value from the set, if it is found, and returns a reference to the set. If the @@ -611,8 +611,8 @@ */ /*! - \fn QSet &QSet::operator|=(const QSet &other) - \fn QSet &QSet::operator+=(const QSet &other) + \fn template QSet &QSet::operator|=(const QSet &other) + \fn template QSet &QSet::operator+=(const QSet &other) Same as unite(\a other). @@ -620,7 +620,7 @@ */ /*! - \fn QSet &QSet::operator&=(const QSet &other) + \fn template QSet &QSet::operator&=(const QSet &other) Same as intersect(\a other). @@ -628,7 +628,7 @@ */ /*! - \fn QSet &QSet::operator&=(const T &value) + \fn template QSet &QSet::operator&=(const T &value) \overload @@ -638,7 +638,7 @@ /*! - \fn QSet &QSet::operator-=(const QSet &other) + \fn template QSet &QSet::operator-=(const QSet &other) Same as subtract(\a{other}). @@ -646,8 +646,8 @@ */ /*! - \fn QSet QSet::operator|(const QSet &other) const - \fn QSet QSet::operator+(const QSet &other) const + \fn template QSet QSet::operator|(const QSet &other) const + \fn template QSet QSet::operator+(const QSet &other) const Returns a new QSet that is the union of this set and the \a other set. @@ -656,7 +656,7 @@ */ /*! - \fn QSet QSet::operator&(const QSet &other) const + \fn template QSet QSet::operator&(const QSet &other) const Returns a new QSet that is the intersection of this set and the \a other set. @@ -665,7 +665,7 @@ */ /*! - \fn QSet QSet::operator-(const QSet &other) const + \fn template QSet QSet::operator-(const QSet &other) const Returns a new QSet that is the set difference of this set and the \a other set, i.e., this set - \a other set. @@ -766,8 +766,8 @@ */ /*! - \fn QSet::iterator::iterator() - \fn QSet::const_iterator::const_iterator() + \fn template QSet::iterator::iterator() + \fn template QSet::const_iterator::const_iterator() Constructs an uninitialized iterator. @@ -779,8 +779,8 @@ */ /*! - \fn QSet::iterator::iterator(typename Hash::iterator i) - \fn QSet::const_iterator::const_iterator(typename Hash::const_iterator i) + \fn template QSet::iterator::iterator(typename Hash::iterator i) + \fn template QSet::const_iterator::const_iterator(typename Hash::const_iterator i) \internal */ @@ -822,14 +822,14 @@ */ /*! - \fn QSet::iterator::iterator(const iterator &other) - \fn QSet::const_iterator::const_iterator(const const_iterator &other) + \fn template QSet::iterator::iterator(const iterator &other) + \fn template QSet::const_iterator::const_iterator(const const_iterator &other) Constructs a copy of \a other. */ /*! - \fn QSet::const_iterator::const_iterator(const iterator &other) + \fn template QSet::const_iterator::const_iterator(const iterator &other) \since 4.2 \overload @@ -837,15 +837,15 @@ */ /*! - \fn QSet::iterator &QSet::iterator::operator=(const iterator &other) - \fn QSet::const_iterator &QSet::const_iterator::operator=(const const_iterator &other) + \fn template QSet::iterator &QSet::iterator::operator=(const iterator &other) + \fn template QSet::const_iterator &QSet::const_iterator::operator=(const const_iterator &other) Assigns \a other to this iterator. */ /*! - \fn const T &QSet::iterator::operator*() const - \fn const T &QSet::const_iterator::operator*() const + \fn template const T &QSet::iterator::operator*() const + \fn template const T &QSet::const_iterator::operator*() const Returns a reference to the current item. @@ -853,8 +853,8 @@ */ /*! - \fn const T *QSet::iterator::operator->() const - \fn const T *QSet::const_iterator::operator->() const + \fn template const T *QSet::iterator::operator->() const + \fn template const T *QSet::const_iterator::operator->() const Returns a pointer to the current item. @@ -862,8 +862,8 @@ */ /*! - \fn bool QSet::iterator::operator==(const iterator &other) const - \fn bool QSet::const_iterator::operator==(const const_iterator &other) const + \fn template bool QSet::iterator::operator==(const iterator &other) const + \fn template bool QSet::const_iterator::operator==(const const_iterator &other) const Returns \c true if \a other points to the same item as this iterator; otherwise returns \c false. @@ -872,15 +872,15 @@ */ /*! - \fn bool QSet::iterator::operator==(const const_iterator &other) const - \fn bool QSet::iterator::operator!=(const const_iterator &other) const + \fn template bool QSet::iterator::operator==(const const_iterator &other) const + \fn template bool QSet::iterator::operator!=(const const_iterator &other) const \overload */ /*! - \fn bool QSet::iterator::operator!=(const iterator &other) const - \fn bool QSet::const_iterator::operator!=(const const_iterator &other) const + \fn template bool QSet::iterator::operator!=(const iterator &other) const + \fn template bool QSet::const_iterator::operator!=(const const_iterator &other) const Returns \c true if \a other points to a different item than this iterator; otherwise returns \c false. @@ -889,22 +889,22 @@ */ /*! - \fn QSet::iterator &QSet::iterator::operator++() - \fn QSet::const_iterator &QSet::const_iterator::operator++() + \fn template QSet::iterator &QSet::iterator::operator++() + \fn template QSet::const_iterator &QSet::const_iterator::operator++() The prefix ++ operator (\c{++it}) advances the iterator to the next item in the set and returns an iterator to the new current item. - Calling this function on QSet::constEnd() leads to + Calling this function on QSet::constEnd() leads to undefined results. \sa operator--() */ /*! - \fn QSet::iterator QSet::iterator::operator++(int) - \fn QSet::const_iterator QSet::const_iterator::operator++(int) + \fn template QSet::iterator QSet::iterator::operator++(int) + \fn template QSet::const_iterator QSet::const_iterator::operator++(int) \overload @@ -914,8 +914,8 @@ */ /*! - \fn QSet::iterator &QSet::iterator::operator--() - \fn QSet::const_iterator &QSet::const_iterator::operator--() + \fn template QSet::iterator &QSet::iterator::operator--() + \fn template QSet::const_iterator &QSet::const_iterator::operator--() The prefix -- operator (\c{--it}) makes the preceding item current and returns an iterator to the new current item. @@ -927,8 +927,8 @@ */ /*! - \fn QSet::iterator QSet::iterator::operator--(int) - \fn QSet::const_iterator QSet::const_iterator::operator--(int) + \fn template QSet::iterator QSet::iterator::operator--(int) + \fn template QSet::const_iterator QSet::const_iterator::operator--(int) \overload @@ -937,8 +937,8 @@ */ /*! - \fn QSet::iterator QSet::iterator::operator+(int j) const - \fn QSet::const_iterator QSet::const_iterator::operator+(int j) const + \fn template QSet::iterator QSet::iterator::operator+(int j) const + \fn template QSet::const_iterator QSet::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.) @@ -949,8 +949,8 @@ */ /*! - \fn QSet::iterator QSet::iterator::operator-(int j) const - \fn QSet::const_iterator QSet::const_iterator::operator-(int j) const + \fn template QSet::iterator QSet::iterator::operator-(int j) const + \fn template QSet::const_iterator QSet::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.) @@ -961,8 +961,8 @@ */ /*! - \fn QSet::iterator &QSet::iterator::operator+=(int j) - \fn QSet::const_iterator &QSet::const_iterator::operator+=(int j) + \fn template QSet::iterator &QSet::iterator::operator+=(int j) + \fn template QSet::const_iterator &QSet::const_iterator::operator+=(int j) Advances the iterator by \a j items. (If \a j is negative, the iterator goes backward.) @@ -973,8 +973,8 @@ */ /*! - \fn QSet::iterator &QSet::iterator::operator-=(int j) - \fn QSet::const_iterator &QSet::const_iterator::operator-=(int j) + \fn template QSet::iterator &QSet::iterator::operator-=(int j) + \fn template QSet::const_iterator &QSet::const_iterator::operator-=(int j) Makes the iterator go back by \a j items. (If \a j is negative, the iterator goes forward.) @@ -984,7 +984,7 @@ \sa operator+=(), operator-() */ -/*! \fn QList QSet::toList() const +/*! \fn template QList QSet::toList() const Returns a new QList containing the elements in the set. The order of the elements in the QList is undefined. @@ -996,7 +996,7 @@ \sa fromList(), QList::fromSet() */ -/*! \fn QList QSet::values() const +/*! \fn template QList QSet::values() const Returns a new QList containing the elements in the set. The order of the elements in the QList is undefined. @@ -1007,7 +1007,7 @@ */ -/*! \fn QSet QSet::fromList(const QList &list) +/*! \fn template QSet QSet::fromList(const QList &list) Returns a new QSet object containing the data contained in \a list. Since QSet doesn't allow duplicates, the resulting QSet @@ -1022,7 +1022,7 @@ */ /*! - \fn QDataStream &operator<<(QDataStream &out, const QSet &set) + \fn template QDataStream &operator<<(QDataStream &out, const QSet &set) \relates QSet Writes the \a set to stream \a out. @@ -1033,7 +1033,7 @@ */ /*! - \fn QDataStream &operator>>(QDataStream &in, QSet &set) + \fn template QDataStream &operator>>(QDataStream &in, QSet &set) \relates QSet Reads a set from stream \a in into \a set. @@ -1044,7 +1044,7 @@ */ /*! - \fn uint qHash(const QSet &key, uint seed = 0) + \fn template uint qHash(const QSet &key, uint seed = 0) \relates QHash \since 5.5 -- cgit v1.2.3