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/qhash.cpp | 250 ++++++++++++++++++++++---------------------- 1 file changed, 125 insertions(+), 125 deletions(-) (limited to 'src/corelib/tools/qhash.cpp') diff --git a/src/corelib/tools/qhash.cpp b/src/corelib/tools/qhash.cpp index 501f0d345f..e110a6095f 100644 --- a/src/corelib/tools/qhash.cpp +++ b/src/corelib/tools/qhash.cpp @@ -1242,7 +1242,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa QHashIterator, QMutableHashIterator, QMap, QSet */ -/*! \fn QHash::QHash() +/*! \fn template QHash::QHash() Constructs an empty hash. @@ -1250,7 +1250,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn QHash::QHash(QHash &&other) + \fn template QHash::QHash(QHash &&other) Move-constructs a QHash instance, making it point at the same object that \a other was pointing to. @@ -1258,7 +1258,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \since 5.2 */ -/*! \fn QHash::QHash(std::initializer_list > list) +/*! \fn template QHash::QHash(std::initializer_list > list) \since 5.1 Constructs a hash with a copy of each of the elements in the @@ -1268,7 +1268,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW compiled in C++11 mode. */ -/*! \fn QHash::QHash(const QHash &other) +/*! \fn template QHash::QHash(const QHash &other) Constructs a copy of \a other. @@ -1280,40 +1280,40 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator=() */ -/*! \fn QHash::~QHash() +/*! \fn template QHash::~QHash() Destroys the hash. References to the values in the hash and all iterators of this hash become invalid. */ -/*! \fn QHash &QHash::operator=(const QHash &other) +/*! \fn template QHash &QHash::operator=(const QHash &other) Assigns \a other to this hash and returns a reference to this hash. */ /*! - \fn QHash &QHash::operator=(QHash &&other) + \fn template QHash &QHash::operator=(QHash &&other) Move-assigns \a other to this QHash instance. \since 5.2 */ -/*! \fn void QHash::swap(QHash &other) +/*! \fn template void QHash::swap(QHash &other) \since 4.8 Swaps hash \a other with this hash. This operation is very fast and never fails. */ -/*! \fn void QMultiHash::swap(QMultiHash &other) +/*! \fn template void QMultiHash::swap(QMultiHash &other) \since 4.8 Swaps hash \a other with this hash. This operation is very fast and never fails. */ -/*! \fn bool QHash::operator==(const QHash &other) const +/*! \fn template bool QHash::operator==(const QHash &other) const Returns \c true if \a other is equal to this hash; otherwise returns false. @@ -1326,7 +1326,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator!=() */ -/*! \fn bool QHash::operator!=(const QHash &other) const +/*! \fn template bool QHash::operator!=(const QHash &other) const Returns \c true if \a other is not equal to this hash; otherwise returns \c false. @@ -1339,14 +1339,14 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator==() */ -/*! \fn int QHash::size() const +/*! \fn template int QHash::size() const Returns the number of items in the hash. \sa isEmpty(), count() */ -/*! \fn bool QHash::isEmpty() const +/*! \fn template bool QHash::isEmpty() const Returns \c true if the hash contains no items; otherwise returns false. @@ -1354,7 +1354,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa size() */ -/*! \fn int QHash::capacity() const +/*! \fn template int QHash::capacity() const Returns the number of buckets in the QHash's internal hash table. @@ -1366,7 +1366,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa reserve(), squeeze() */ -/*! \fn void QHash::reserve(int size) +/*! \fn template void QHash::reserve(int size) Ensures that the QHash's internal hash table consists of at least \a size buckets. @@ -1389,7 +1389,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa squeeze(), capacity() */ -/*! \fn void QHash::squeeze() +/*! \fn template void QHash::squeeze() Reduces the size of the QHash's internal hash table to save memory. @@ -1401,7 +1401,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa reserve(), capacity() */ -/*! \fn void QHash::detach() +/*! \fn template void QHash::detach() \internal @@ -1411,7 +1411,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa isDetached() */ -/*! \fn bool QHash::isDetached() const +/*! \fn template bool QHash::isDetached() const \internal @@ -1421,24 +1421,24 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa detach() */ -/*! \fn void QHash::setSharable(bool sharable) +/*! \fn template void QHash::setSharable(bool sharable) \internal */ -/*! \fn bool QHash::isSharedWith(const QHash &other) const +/*! \fn template bool QHash::isSharedWith(const QHash &other) const \internal */ -/*! \fn void QHash::clear() +/*! \fn template void QHash::clear() Removes all items from the hash. \sa remove() */ -/*! \fn int QHash::remove(const Key &key) +/*! \fn template int QHash::remove(const Key &key) Removes all the items that have the \a key from the hash. Returns the number of items removed which is usually 1 but will @@ -1448,7 +1448,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa clear(), take(), QMultiHash::remove() */ -/*! \fn T QHash::take(const Key &key) +/*! \fn template T QHash::take(const Key &key) Removes the item with the \a key from the hash and returns the value associated with it. @@ -1463,7 +1463,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa remove() */ -/*! \fn bool QHash::contains(const Key &key) const +/*! \fn template bool QHash::contains(const Key &key) const Returns \c true if the hash contains an item with the \a key; otherwise returns \c false. @@ -1471,7 +1471,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa count(), QMultiHash::contains() */ -/*! \fn const T QHash::value(const Key &key) const +/*! \fn template const T QHash::value(const Key &key) const Returns the value associated with the \a key. @@ -1483,14 +1483,14 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa key(), values(), contains(), operator[]() */ -/*! \fn const T QHash::value(const Key &key, const T &defaultValue) const +/*! \fn template const T QHash::value(const Key &key, const T &defaultValue) const \overload If the hash contains no item with the given \a key, the function returns \a defaultValue. */ -/*! \fn T &QHash::operator[](const Key &key) +/*! \fn template T &QHash::operator[](const Key &key) Returns the value associated with the \a key as a modifiable reference. @@ -1504,14 +1504,14 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa insert(), value() */ -/*! \fn const T QHash::operator[](const Key &key) const +/*! \fn template const T QHash::operator[](const Key &key) const \overload Same as value(). */ -/*! \fn QList QHash::uniqueKeys() const +/*! \fn template QList QHash::uniqueKeys() const \since 4.2 Returns a list containing all the keys in the map. Keys that occur multiple @@ -1521,7 +1521,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa keys(), values() */ -/*! \fn QList QHash::keys() const +/*! \fn template QList QHash::keys() const Returns a list containing all the keys in the hash, in an arbitrary order. Keys that occur multiple times in the hash @@ -1536,7 +1536,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa uniqueKeys(), values(), key() */ -/*! \fn QList QHash::keys(const T &value) const +/*! \fn template QList QHash::keys(const T &value) const \overload @@ -1548,7 +1548,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW by value. */ -/*! \fn QList QHash::values() const +/*! \fn template QList QHash::values() const Returns a list containing all the values in the hash, in an arbitrary order. If a key is associated with multiple values, all of @@ -1560,7 +1560,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa keys(), value() */ -/*! \fn QList QHash::values(const Key &key) const +/*! \fn template QList QHash::values(const Key &key) const \overload @@ -1570,7 +1570,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa count(), insertMulti() */ -/*! \fn Key QHash::key(const T &value) const +/*! \fn template Key QHash::key(const T &value) const Returns the first key mapped to \a value. @@ -1585,7 +1585,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn Key QHash::key(const T &value, const Key &defaultKey) const + \fn template Key QHash::key(const T &value, const Key &defaultKey) const \since 4.3 \overload @@ -1597,21 +1597,21 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW by value. */ -/*! \fn int QHash::count(const Key &key) const +/*! \fn template int QHash::count(const Key &key) const Returns the number of items associated with the \a key. \sa contains(), insertMulti() */ -/*! \fn int QHash::count() const +/*! \fn template int QHash::count() const \overload Same as size(). */ -/*! \fn QHash::iterator QHash::begin() +/*! \fn template QHash::iterator QHash::begin() Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first item in the hash. @@ -1619,12 +1619,12 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa constBegin(), end() */ -/*! \fn QHash::const_iterator QHash::begin() const +/*! \fn template QHash::const_iterator QHash::begin() const \overload */ -/*! \fn QHash::const_iterator QHash::cbegin() const +/*! \fn template QHash::const_iterator QHash::cbegin() const \since 5.0 Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item @@ -1633,7 +1633,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa begin(), cend() */ -/*! \fn QHash::const_iterator QHash::constBegin() const +/*! \fn template QHash::const_iterator QHash::constBegin() const Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item in the hash. @@ -1641,7 +1641,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa begin(), constEnd() */ -/*! \fn QHash::key_iterator QHash::keyBegin() const +/*! \fn template QHash::key_iterator QHash::keyBegin() const \since 5.6 Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first key @@ -1650,7 +1650,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa keyEnd() */ -/*! \fn QHash::iterator QHash::end() +/*! \fn template QHash::iterator QHash::end() Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item after the last item in the hash. @@ -1658,12 +1658,12 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa begin(), constEnd() */ -/*! \fn QHash::const_iterator QHash::end() const +/*! \fn template QHash::const_iterator QHash::end() const \overload */ -/*! \fn QHash::const_iterator QHash::constEnd() const +/*! \fn template QHash::const_iterator QHash::constEnd() const Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item after the last item in the hash. @@ -1671,7 +1671,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa constBegin(), end() */ -/*! \fn QHash::const_iterator QHash::cend() const +/*! \fn template QHash::const_iterator QHash::cend() const \since 5.0 Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary @@ -1680,7 +1680,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa cbegin(), end() */ -/*! \fn QHash::key_iterator QHash::keyEnd() const +/*! \fn template QHash::key_iterator QHash::keyEnd() const \since 5.6 Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary @@ -1689,7 +1689,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa keyBegin() */ -/*! \fn QHash::key_value_iterator QHash::keyValueBegin() +/*! \fn template QHash::key_value_iterator QHash::keyValueBegin() \since 5.10 Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first entry @@ -1698,7 +1698,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa keyValueEnd() */ -/*! \fn QHash::key_value_iterator QHash::keyValueEnd() +/*! \fn template QHash::key_value_iterator QHash::keyValueEnd() \since 5.10 Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary @@ -1707,7 +1707,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa keyValueBegin() */ -/*! \fn QHash::const_key_value_iterator QHash::keyValueBegin() const +/*! \fn template QHash::const_key_value_iterator QHash::keyValueBegin() const \since 5.10 Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first entry @@ -1716,7 +1716,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa keyValueEnd() */ -/*! \fn QHash::const_key_value_iterator QHash::constKeyValueBegin() const +/*! \fn template QHash::const_key_value_iterator QHash::constKeyValueBegin() const \since 5.10 Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first entry @@ -1725,7 +1725,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa keyValueBegin() */ -/*! \fn QHash::const_key_value_iterator QHash::keyValueEnd() const +/*! \fn template QHash::const_key_value_iterator QHash::keyValueEnd() const \since 5.10 Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary @@ -1734,7 +1734,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa keyValueBegin() */ -/*! \fn QHash::const_key_value_iterator QHash::constKeyValueEnd() const +/*! \fn template QHash::const_key_value_iterator QHash::constKeyValueEnd() const \since 5.10 Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary @@ -1743,7 +1743,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa constKeyValueBegin() */ -/*! \fn QHash::iterator QHash::erase(const_iterator pos) +/*! \fn template QHash::iterator QHash::erase(const_iterator pos) \since 5.7 Removes the (key, value) pair associated with the iterator \a pos @@ -1760,11 +1760,11 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa remove(), take(), find() */ -/*! \fn QHash::iterator QHash::erase(iterator pos) +/*! \fn template QHash::iterator QHash::erase(iterator pos) \overload */ -/*! \fn QHash::iterator QHash::find(const Key &key) +/*! \fn template QHash::iterator QHash::find(const Key &key) Returns an iterator pointing to the item with the \a key in the hash. @@ -1783,12 +1783,12 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa value(), values(), QMultiHash::find() */ -/*! \fn QHash::const_iterator QHash::find(const Key &key) const +/*! \fn template QHash::const_iterator QHash::find(const Key &key) const \overload */ -/*! \fn QHash::const_iterator QHash::constFind(const Key &key) const +/*! \fn template QHash::const_iterator QHash::constFind(const Key &key) const \since 4.1 Returns an iterator pointing to the item with the \a key in the @@ -1800,7 +1800,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa find(), QMultiHash::constFind() */ -/*! \fn QHash::iterator QHash::insert(const Key &key, const T &value) +/*! \fn template QHash::iterator QHash::insert(const Key &key, const T &value) Inserts a new item with the \a key and a value of \a value. @@ -1813,7 +1813,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa insertMulti() */ -/*! \fn QHash::iterator QHash::insertMulti(const Key &key, const T &value) +/*! \fn template QHash::iterator QHash::insertMulti(const Key &key, const T &value) Inserts a new item with the \a key and a value of \a value. @@ -1825,7 +1825,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa insert(), values() */ -/*! \fn QHash &QHash::unite(const QHash &other) +/*! \fn template QHash &QHash::unite(const QHash &other) Inserts all the items in the \a other hash into this hash. If a key is common to both hashes, the resulting hash will contain the @@ -1834,14 +1834,14 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa insertMulti() */ -/*! \fn bool QHash::empty() const +/*! \fn template bool QHash::empty() const This function is provided for STL compatibility. It is equivalent to isEmpty(), returning true if the hash is empty; otherwise returns \c false. */ -/*! \fn QPair QHash::equal_range(const Key &key) +/*! \fn template QPair QHash::equal_range(const Key &key) \since 5.7 Returns a pair of iterators delimiting the range of values \c{[first, second)}, that @@ -1849,7 +1849,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn QPair QHash::equal_range(const Key &key) const + \fn template QPair QHash::equal_range(const Key &key) const \overload \since 5.7 */ @@ -2020,7 +2020,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa QHash::const_iterator, QHash::key_iterator, QMutableHashIterator */ -/*! \fn QHash::iterator::iterator() +/*! \fn template QHash::iterator::iterator() Constructs an uninitialized iterator. @@ -2031,12 +2031,12 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa QHash::begin(), QHash::end() */ -/*! \fn QHash::iterator::iterator(void *node) +/*! \fn template QHash::iterator::iterator(void *node) \internal */ -/*! \fn const Key &QHash::iterator::key() const +/*! \fn template const Key &QHash::iterator::key() const Returns the current item's key as a const reference. @@ -2047,7 +2047,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa value() */ -/*! \fn T &QHash::iterator::value() const +/*! \fn template T &QHash::iterator::value() const Returns a modifiable reference to the current item's value. @@ -2059,7 +2059,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa key(), operator*() */ -/*! \fn T &QHash::iterator::operator*() const +/*! \fn template T &QHash::iterator::operator*() const Returns a modifiable reference to the current item's value. @@ -2068,7 +2068,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa key() */ -/*! \fn T *QHash::iterator::operator->() const +/*! \fn template T *QHash::iterator::operator->() const Returns a pointer to the current item's value. @@ -2076,8 +2076,8 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn bool QHash::iterator::operator==(const iterator &other) const - \fn bool QHash::iterator::operator==(const const_iterator &other) const + \fn template bool QHash::iterator::operator==(const iterator &other) const + \fn template bool QHash::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. @@ -2086,8 +2086,8 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn bool QHash::iterator::operator!=(const iterator &other) const - \fn bool QHash::iterator::operator!=(const const_iterator &other) const + \fn template bool QHash::iterator::operator!=(const iterator &other) const + \fn template bool QHash::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. @@ -2096,7 +2096,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn QHash::iterator &QHash::iterator::operator++() + \fn template QHash::iterator &QHash::iterator::operator++() The prefix ++ operator (\c{++i}) advances the iterator to the next item in the hash and returns an iterator to the new current @@ -2107,7 +2107,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator--() */ -/*! \fn QHash::iterator QHash::iterator::operator++(int) +/*! \fn template QHash::iterator QHash::iterator::operator++(int) \overload @@ -2117,7 +2117,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn QHash::iterator &QHash::iterator::operator--() + \fn template QHash::iterator &QHash::iterator::operator--() The prefix -- operator (\c{--i}) makes the preceding item current and returns an iterator pointing to the new current item. @@ -2129,7 +2129,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn QHash::iterator QHash::iterator::operator--(int) + \fn template QHash::iterator QHash::iterator::operator--(int) \overload @@ -2138,7 +2138,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW current item. */ -/*! \fn QHash::iterator QHash::iterator::operator+(int j) const +/*! \fn template QHash::iterator QHash::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.) @@ -2149,7 +2149,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ -/*! \fn QHash::iterator QHash::iterator::operator-(int j) const +/*! \fn template QHash::iterator QHash::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.) @@ -2159,7 +2159,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator+() */ -/*! \fn QHash::iterator &QHash::iterator::operator+=(int j) +/*! \fn template QHash::iterator &QHash::iterator::operator+=(int j) Advances the iterator by \a j items. (If \a j is negative, the iterator goes backward.) @@ -2167,7 +2167,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator-=(), operator+() */ -/*! \fn QHash::iterator &QHash::iterator::operator-=(int j) +/*! \fn template QHash::iterator &QHash::iterator::operator-=(int j) Makes the iterator go back by \a j items. (If \a j is negative, the iterator goes forward.) @@ -2222,7 +2222,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa QHash::iterator, QHashIterator */ -/*! \fn QHash::const_iterator::const_iterator() +/*! \fn template QHash::const_iterator::const_iterator() Constructs an uninitialized iterator. @@ -2233,31 +2233,31 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa QHash::constBegin(), QHash::constEnd() */ -/*! \fn QHash::const_iterator::const_iterator(void *node) +/*! \fn template QHash::const_iterator::const_iterator(void *node) \internal */ -/*! \fn QHash::const_iterator::const_iterator(const iterator &other) +/*! \fn template QHash::const_iterator::const_iterator(const iterator &other) Constructs a copy of \a other. */ -/*! \fn const Key &QHash::const_iterator::key() const +/*! \fn template const Key &QHash::const_iterator::key() const Returns the current item's key. \sa value() */ -/*! \fn const T &QHash::const_iterator::value() const +/*! \fn template const T &QHash::const_iterator::value() const Returns the current item's value. \sa key(), operator*() */ -/*! \fn const T &QHash::const_iterator::operator*() const +/*! \fn template const T &QHash::const_iterator::operator*() const Returns the current item's value. @@ -2266,14 +2266,14 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa key() */ -/*! \fn const T *QHash::const_iterator::operator->() const +/*! \fn template const T *QHash::const_iterator::operator->() const Returns a pointer to the current item's value. \sa value() */ -/*! \fn bool QHash::const_iterator::operator==(const const_iterator &other) const +/*! \fn template bool QHash::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. @@ -2281,7 +2281,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator!=() */ -/*! \fn bool QHash::const_iterator::operator!=(const const_iterator &other) const +/*! \fn template bool QHash::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. @@ -2290,7 +2290,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn QHash::const_iterator &QHash::const_iterator::operator++() + \fn template QHash::const_iterator &QHash::const_iterator::operator++() The prefix ++ operator (\c{++i}) advances the iterator to the next item in the hash and returns an iterator to the new current @@ -2301,7 +2301,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator--() */ -/*! \fn QHash::const_iterator QHash::const_iterator::operator++(int) +/*! \fn template QHash::const_iterator QHash::const_iterator::operator++(int) \overload @@ -2310,7 +2310,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW current item. */ -/*! \fn QHash::const_iterator &QHash::const_iterator::operator--() +/*! \fn template QHash::const_iterator &QHash::const_iterator::operator--() The prefix -- operator (\c{--i}) makes the preceding item current and returns an iterator pointing to the new current item. @@ -2321,7 +2321,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator++() */ -/*! \fn QHash::const_iterator QHash::const_iterator::operator--(int) +/*! \fn template QHash::const_iterator QHash::const_iterator::operator--(int) \overload @@ -2330,7 +2330,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW current item. */ -/*! \fn QHash::const_iterator QHash::const_iterator::operator+(int j) const +/*! \fn template QHash::const_iterator QHash::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.) @@ -2340,7 +2340,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator-() */ -/*! \fn QHash::const_iterator QHash::const_iterator::operator-(int j) const +/*! \fn template QHash::const_iterator QHash::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.) @@ -2350,7 +2350,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator+() */ -/*! \fn QHash::const_iterator &QHash::const_iterator::operator+=(int j) +/*! \fn template QHash::const_iterator &QHash::const_iterator::operator+=(int j) Advances the iterator by \a j items. (If \a j is negative, the iterator goes backward.) @@ -2360,7 +2360,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator-=(), operator+() */ -/*! \fn QHash::const_iterator &QHash::const_iterator::operator-=(int j) +/*! \fn template QHash::const_iterator &QHash::const_iterator::operator-=(int j) Makes the iterator go back by \a j items. (If \a j is negative, the iterator goes forward.) @@ -2407,17 +2407,17 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa QHash::const_iterator, QHash::iterator */ -/*! \fn const T &QHash::key_iterator::operator*() const +/*! \fn template const T &QHash::key_iterator::operator*() const Returns the current item's key. */ -/*! \fn const T *QHash::key_iterator::operator->() const +/*! \fn template const T *QHash::key_iterator::operator->() const Returns a pointer to the current item's key. */ -/*! \fn bool QHash::key_iterator::operator==(key_iterator other) const +/*! \fn template bool QHash::key_iterator::operator==(key_iterator other) const Returns \c true if \a other points to the same item as this iterator; otherwise returns \c false. @@ -2425,7 +2425,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator!=() */ -/*! \fn bool QHash::key_iterator::operator!=(key_iterator other) const +/*! \fn template bool QHash::key_iterator::operator!=(key_iterator other) const Returns \c true if \a other points to a different item than this iterator; otherwise returns \c false. @@ -2434,7 +2434,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn QHash::key_iterator &QHash::key_iterator::operator++() + \fn template QHash::key_iterator &QHash::key_iterator::operator++() The prefix ++ operator (\c{++i}) advances the iterator to the next item in the hash and returns an iterator to the new current @@ -2445,7 +2445,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator--() */ -/*! \fn QHash::key_iterator QHash::key_iterator::operator++(int) +/*! \fn template QHash::key_iterator QHash::key_iterator::operator++(int) \overload @@ -2454,7 +2454,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW item. */ -/*! \fn QHash::key_iterator &QHash::key_iterator::operator--() +/*! \fn template QHash::key_iterator &QHash::key_iterator::operator--() The prefix -- operator (\c{--i}) makes the preceding item current and returns an iterator pointing to the new current item. @@ -2465,7 +2465,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator++() */ -/*! \fn QHash::key_iterator QHash::key_iterator::operator--(int) +/*! \fn template QHash::key_iterator QHash::key_iterator::operator--(int) \overload @@ -2474,7 +2474,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW item. */ -/*! \fn const_iterator QHash::key_iterator::base() const +/*! \fn template const_iterator QHash::key_iterator::base() const Returns the underlying const_iterator this key_iterator is based on. */ @@ -2490,7 +2490,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa QKeyValueIterator */ -/*! \fn QDataStream &operator<<(QDataStream &out, const QHash& hash) +/*! \fn template QDataStream &operator<<(QDataStream &out, const QHash& hash) \relates QHash Writes the hash \a hash to stream \a out. @@ -2501,7 +2501,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa {Serializing Qt Data Types} */ -/*! \fn QDataStream &operator>>(QDataStream &in, QHash &hash) +/*! \fn template QDataStream &operator>>(QDataStream &in, QHash &hash) \relates QHash Reads a hash from stream \a in into \a hash. @@ -2568,12 +2568,12 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa QHash, QHashIterator, QMutableHashIterator, QMultiMap */ -/*! \fn QMultiHash::QMultiHash() +/*! \fn template QMultiHash::QMultiHash() Constructs an empty hash. */ -/*! \fn QMultiHash::QMultiHash(std::initializer_list > list) +/*! \fn template QMultiHash::QMultiHash(std::initializer_list > list) \since 5.1 Constructs a multi-hash with a copy of each of the elements in the @@ -2583,7 +2583,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW compiled in C++11 mode. */ -/*! \fn QMultiHash::QMultiHash(const QHash &other) +/*! \fn template QMultiHash::QMultiHash(const QHash &other) Constructs a copy of \a other (which can be a QHash or a QMultiHash). @@ -2591,7 +2591,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa operator=() */ -/*! \fn QMultiHash::iterator QMultiHash::replace(const Key &key, const T &value) +/*! \fn template QMultiHash::iterator QMultiHash::replace(const Key &key, const T &value) Inserts a new item with the \a key and a value of \a value. @@ -2604,7 +2604,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa insert() */ -/*! \fn QMultiHash::iterator QMultiHash::insert(const Key &key, const T &value) +/*! \fn template QMultiHash::iterator QMultiHash::insert(const Key &key, const T &value) Inserts a new item with the \a key and a value of \a value. @@ -2616,7 +2616,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa replace() */ -/*! \fn QMultiHash &QMultiHash::operator+=(const QMultiHash &other) +/*! \fn template QMultiHash &QMultiHash::operator+=(const QMultiHash &other) Inserts all the items in the \a other hash into this hash and returns a reference to this hash. @@ -2624,7 +2624,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW \sa insert() */ -/*! \fn QMultiHash QMultiHash::operator+(const QMultiHash &other) const +/*! \fn template QMultiHash QMultiHash::operator+(const QMultiHash &other) const Returns a hash that contains all the items in this hash in addition to all the items in \a other. If a key is common to both @@ -2634,7 +2634,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn bool QMultiHash::contains(const Key &key, const T &value) const + \fn template bool QMultiHash::contains(const Key &key, const T &value) const \since 4.3 Returns \c true if the hash contains an item with the \a key and @@ -2644,7 +2644,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn int QMultiHash::remove(const Key &key, const T &value) + \fn template int QMultiHash::remove(const Key &key, const T &value) \since 4.3 Removes all the items that have the \a key and the value \a @@ -2654,7 +2654,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn int QMultiHash::count(const Key &key, const T &value) const + \fn template int QMultiHash::count(const Key &key, const T &value) const \since 4.3 Returns the number of items with the \a key and \a value. @@ -2663,7 +2663,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn typename QHash::iterator QMultiHash::find(const Key &key, const T &value) + \fn template typename QHash::iterator QMultiHash::find(const Key &key, const T &value) \since 4.3 Returns an iterator pointing to the item with the \a key and \a value. @@ -2676,13 +2676,13 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn typename QHash::const_iterator QMultiHash::find(const Key &key, const T &value) const + \fn template typename QHash::const_iterator QMultiHash::find(const Key &key, const T &value) const \since 4.3 \overload */ /*! - \fn typename QHash::const_iterator QMultiHash::constFind(const Key &key, const T &value) const + \fn template typename QHash::const_iterator QMultiHash::constFind(const Key &key, const T &value) const \since 4.3 Returns an iterator pointing to the item with the \a key and the @@ -2695,7 +2695,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn uint qHash(const QHash &key, uint seed = 0) + \fn template uint qHash(const QHash &key, uint seed = 0) \since 5.8 \relates QHash @@ -2705,7 +2705,7 @@ uint qHash(long double key, uint seed) Q_DECL_NOTHROW */ /*! - \fn uint qHash(const QMultiHash &key, uint seed = 0) + \fn template uint qHash(const QMultiHash &key, uint seed = 0) \since 5.8 \relates QMultiHash -- cgit v1.2.3