Documentation: purge QSet and QHash members that no longer exist

QMutableSet/HashIterator can not walk backwards, neither can the STL iterator.
When function documentation was shared with other iterator types, move it into
separate section to avoid linking to incorrect see-alsos.

Remove or fix other member function documentation that had errors, e.g.
in parameter types after move to qsizetype.

Change-Id: Ic7f97a295eff63ee748998b10f08a160706fa650
Reviewed-by: Lars Knoll <lars.knoll@qt.io>

1 files changed, 1 insertions, 270 deletions

diff --git a/src/corelib/tools/qset.qdoc b/src/corelib/tools/qset.qdoc
index b6aae2c7ca..a98ce6cb06 100644
--- a/src/corelib/tools/qset.qdoc
+++ b/src/corelib/tools/qset.qdoc
@@ -185,7 +185,7 @@
     \sa reserve(), squeeze()
 */
 
-/*! \fn template <class T> void QSet<T>::reserve(int size)
+/*! \fn template <class T> void QSet<T>::reserve(qsizetype size)
 
     Ensures that the set's internal hash table consists of at
     least \a size buckets.
@@ -278,12 +278,6 @@
     \sa remove(), find()
 */
 
-/*!
-    \fn template <class T> QSet<T>::iterator QSet<T>::erase(iterator pos)
-    \since 4.2
-    \overload
-*/
-
 /*! \fn template <class T> QSet<T>::const_iterator QSet<T>::find(const T &value) const
     \since 4.2
 
@@ -398,58 +392,6 @@
     \sa constBegin(), end()
 */
 
-/*! \fn template <class T> QSet<T>::reverse_iterator QSet<T>::rbegin()
-    \obsolete Deprecated in order to align with std::unordered_set functionality.
-    \since 5.6
-
-    Returns a \l{STL-style iterators}{STL-style} reverse iterator pointing to the first
-    item in the set, in reverse order.
-
-    \sa begin(), crbegin(), rend()
-*/
-
-/*! \fn template <class T> QSet<T>::const_reverse_iterator QSet<T>::rbegin() const
-    \obsolete Deprecated in order to align with std::unordered_set functionality.
-    \since 5.6
-    \overload
-*/
-
-/*! \fn template <class T> QSet<T>::const_reverse_iterator QSet<T>::crbegin() const
-    \obsolete Deprecated in order to align with std::unordered_set functionality.
-    \since 5.6
-
-    Returns a const \l{STL-style iterators}{STL-style} reverse iterator pointing to the first
-    item in the set, in reverse order.
-
-    \sa begin(), rbegin(), rend()
-*/
-
-/*! \fn template <class T> QSet<T>::reverse_iterator QSet<T>::rend()
-    \obsolete Deprecated in order to align with std::unordered_set functionality.
-    \since 5.6
-
-    Returns a \l{STL-style iterators}{STL-style} reverse iterator pointing to one past
-    the last item in the set, in reverse order.
-
-    \sa end(), crend(), rbegin()
-*/
-
-/*! \fn template <class T> QSet<T>::const_reverse_iterator QSet<T>::rend() const
-    \obsolete Deprecated in order to align with std::unordered_set functionality.
-    \since 5.6
-    \overload
-*/
-
-/*! \fn template <class T> QSet<T>::const_reverse_iterator QSet<T>::crend() const
-    \obsolete Deprecated in order to align with std::unordered_set functionality.
-    \since 5.6
-
-    Returns a const \l{STL-style iterators}{STL-style} reverse iterator pointing to one
-    past the last item in the set, in reverse order.
-
-    \sa end(), rend(), rbegin()
-*/
-
 /*!
     \typedef QSet::Iterator
     \since 4.2
@@ -511,40 +453,6 @@
     Typedef for T. Provided for STL compatibility.
 */
 
-/*! \typedef QSet::reverse_iterator
-    \since 5.6
-    \obsolete Deprecated in order to align with std::unordered_set functionality.
-
-    The QSet::reverse_iterator typedef provides an STL-style non-const
-    reverse iterator for QSet.
-
-    It is simply a typedef for \c{std::reverse_iterator<QSet::iterator>}.
-
-    \warning Iterators on implicitly shared containers do not work
-    exactly like STL-iterators. You should avoid copying a container
-    while iterators are active on that container. For more information,
-    read \l{Implicit sharing iterator problem}.
-
-    \sa QSet::rbegin(), QSet::rend(), QSet::const_reverse_iterator, QSet::iterator
-*/
-
-/*! \typedef QSet::const_reverse_iterator
-    \since 5.6
-    \obsolete Deprecated in order to align with std::unordered_set functionality.
-
-    The QSet::const_reverse_iterator typedef provides an STL-style const
-    reverse iterator for QSet.
-
-    It is simply a typedef for \c{std::reverse_iterator<QSet::const_iterator>}.
-
-    \warning Iterators on implicitly shared containers do not work
-    exactly like STL-iterators. You should avoid copying a container
-    while iterators are active on that container. For more information,
-    read \l{Implicit sharing iterator problem}.
-
-    \sa QSet::rbegin(), QSet::rend(), QSet::reverse_iterator, QSet::const_iterator
-*/
-
 /*!
     \fn template <class T> QSet<T>::insert(const T &value)
 
@@ -927,196 +835,19 @@
     current item.
 */
 
-/*!
-    \fn template <class T> QSet<T>::iterator &QSet<T>::iterator::operator--()
-    \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
-
-    The prefix -- operator (\c{--it}) makes the preceding item
-    current and returns an iterator to the new current item.
-
-    Calling this function on QSet::begin() leads to undefined
-    results.
-
-    \sa operator++()
-*/
-
-/*!
-    \fn template <class T> QSet<T>::const_iterator &QSet<T>::const_iterator::operator--()
-    \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
-
-    The prefix -- operator (\c{--it}) makes the preceding item
-    current and returns an iterator to the new current item.
-
-    Calling this function on QSet::begin() leads to undefined
-    results.
-
-    \sa operator++()
-*/
-
-/*!
-    \fn template <class T> QSet<T>::iterator QSet<T>::iterator::operator--(int)
-    \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
-
-    \overload
-
-    The postfix -- operator (\c{it--}) makes the preceding item
-    current and returns an iterator to the previously current item.
-*/
-
-/*!
-    \fn template <class T> QSet<T>::const_iterator QSet<T>::const_iterator::operator--(int)
-    \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
-
-    \overload
-
-    The postfix -- operator (\c{it--}) makes the preceding item
-    current and returns an iterator to the previously current item.
-*/
-
-/*!
-    \fn template <class T> QSet<T>::iterator QSet<T>::iterator::operator+(int j) const
-    \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
-
-    Returns an iterator to the item at \a j positions forward from
-    this iterator. (If \a j is negative, the iterator goes backward.)
-
-    This operation can be slow for large \a j values.
-
-    \sa operator-()
-*/
-
-/*!
-    \fn template <class T> QSet<T>::const_iterator QSet<T>::const_iterator::operator+(int j) const
-    \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
-
-    Returns an iterator to the item at \a j positions forward from
-    this iterator. (If \a j is negative, the iterator goes backward.)
-
-    This operation can be slow for large \a j values.
-
-    \sa operator-()
-*/
-
-/*!
-    \fn template <class T> QSet<T>::iterator QSet<T>::iterator::operator-(int j) const
-    \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
-
-    Returns an iterator to the item at \a j positions backward from
-    this iterator. (If \a j is negative, the iterator goes forward.)
-
-    This operation can be slow for large \a j values.
-
-    \sa operator+()
-*/
-
-/*!
-    \fn template <class T> QSet<T>::const_iterator QSet<T>::const_iterator::operator-(int j) const
-    \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
-
-    Returns an iterator to the item at \a j positions backward from
-    this iterator. (If \a j is negative, the iterator goes forward.)
-
-    This operation can be slow for large \a j values.
-
-    \sa operator+()
-*/
-
-/*!
-    \fn template <class T> QSet<T>::iterator &QSet<T>::iterator::operator+=(int j)
-    \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
-
-    Advances the iterator by \a j items. (If \a j is negative, the
-    iterator goes backward.)
-
-    This operation can be slow for large \a j values.
-
-    \sa operator-=(), operator+()
-
-*/
-
-/*!
-    \fn template <class T> QSet<T>::const_iterator &QSet<T>::const_iterator::operator+=(int j)
-    \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
-
-    Advances the iterator by \a j items. (If \a j is negative, the
-    iterator goes backward.)
-
-    This operation can be slow for large \a j values.
-
-    \sa operator-=(), operator+()
-*/
-
-/*!
-    \fn template <class T> QSet<T>::iterator &QSet<T>::iterator::operator-=(int j)
-    \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
-
-    Makes the iterator go back by \a j items. (If \a j is negative,
-    the iterator goes forward.)
-
-    This operation can be slow for large \a j values.
-
-    \sa operator+=(), operator-()
-*/
-
-/*!
-    \fn template <class T> QSet<T>::const_iterator &QSet<T>::const_iterator::operator-=(int j)
-    \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
-
-    Makes the iterator go back by \a j items. (If \a j is negative,
-    the iterator goes forward.)
-
-    This operation can be slow for large \a j values.
-
-    \sa operator+=(), operator-()
-*/
-
-/*! \fn template <class T> QList<T> QSet<T>::toList() const
-
-    Returns a new QList containing the elements in the set. The
-    order of the elements in the QList is undefined.
-
-    Example:
-
-    \snippet code/doc_src_qset.cpp 13
-
-    \include containers-range-constructor.qdocinc
-
-    \sa fromList(), QList::fromSet()
-*/
-
 /*! \fn template <class T> QList<T> QSet<T>::values() const
 
     Returns a new QList containing the elements in the set. The
     order of the elements in the QList is undefined.
 
-    This is the same as toList().
-
     \include containers-range-constructor.qdocinc
 
     This function creates a new list, in \l {linear time}. The time and memory
     use that entails can be avoided by iterating from \l constBegin() to
     \l constEnd().
-
-    \sa fromList(), QList::fromSet()
 */
 
 
-/*! \fn template <class T> QSet<T> QSet<T>::fromList(const QList<T> &list)
-
-    Returns a new QSet object containing the data contained in \a
-    list. Since QSet doesn't allow duplicates, the resulting QSet
-    might be smaller than the \a list, because QList can contain
-    duplicates.
-
-    Example:
-
-    \snippet code/doc_src_qset.cpp 14
-
-    \include containers-range-constructor.qdocinc
-
-    \sa toList(), QList::toSet()
-*/
-
 /*!
     \fn template <class T> QDataStream &operator<<(QDataStream &out, const QSet<T> &set)
     \relates QSet