Doc: Mark deprecated QMutableSetIterator functions as \obsolete

Change-Id: I07a4ade20242fbe4139c0b88cf8728dd74628511
Reviewed-by: Lars Knoll <lars.knoll@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>

1 files changed, 50 insertions, 4 deletions

diff --git a/src/corelib/tools/qiterator.qdoc b/src/corelib/tools/qiterator.qdoc
index ed39fe28c3..273370e797 100644
--- a/src/corelib/tools/qiterator.qdoc
+++ b/src/corelib/tools/qiterator.qdoc
@@ -762,6 +762,17 @@
     \sa hasNext(), next(), peekPrevious()
 */
 
+/*!
+    \fn template <class T> bool QMutableSetIterator<T>::hasPrevious() const
+    \obsolete Deprecated in order to align with std::unordered_set functionality.
+
+    Returns \c true if there is at least one item behind the iterator,
+    i.e. the iterator is \e not at the front of the container;
+    otherwise returns \c false.
+
+    \sa hasNext(), previous()
+*/
+
 /*! \fn template <class T> bool QListIterator<T>::hasPrevious() const
     \fn template <class T> bool QLinkedListIterator<T>::hasPrevious() const
     \fn template <class T> bool QVectorIterator<T>::hasPrevious() const
@@ -769,7 +780,6 @@
     \fn template <class T> bool QMutableListIterator<T>::hasPrevious() const
     \fn template <class T> bool QMutableLinkedListIterator<T>::hasPrevious() const
     \fn template <class T> bool QMutableVectorIterator<T>::hasPrevious() const
-    \fn template <class T> bool QMutableSetIterator<T>::hasPrevious() const
 
     Returns \c true if there is at least one item behind the iterator,
     i.e. the iterator is \e not at the front of the container;
@@ -778,11 +788,23 @@
     \sa hasNext(), previous()
 */
 
+/*!
+    \fn template <class T> const T &QMutableSetIterator<T>::previous()
+    \obsolete Deprecated in order to align with std::unordered_set functionality.
+
+    Returns the previous item and moves the iterator back by one
+    position.
+
+    Calling this function on an iterator located at the front of the
+    container leads to undefined results.
+
+    \sa hasPrevious(), peekPrevious(), next()
+*/
+
 /*! \fn template <class T> const T &QListIterator<T>::previous()
     \fn template <class T> const T &QLinkedListIterator<T>::previous()
     \fn template <class T> const T &QVectorIterator<T>::previous()
     \fn template <class T> const T &QSetIterator<T>::previous()
-    \fn template <class T> const T &QMutableSetIterator<T>::previous()
 
     Returns the previous item and moves the iterator back by one
     position.
@@ -806,11 +828,22 @@
     \sa hasPrevious(), peekPrevious(), next()
 */
 
+/*!
+    \fn template <class T> const T &QMutableSetIterator<T>::peekPrevious() const
+    \obsolete Deprecated in order to align with std::unordered_set functionality.
+
+    Returns the previous item without moving the iterator.
+
+    Calling this function on an iterator located at the front of the
+    container leads to undefined results.
+
+    \sa hasPrevious(), previous(), peekNext()
+*/
+
 /*! \fn template <class T> const T &QListIterator<T>::peekPrevious() const
     \fn template <class T> const T &QLinkedListIterator<T>::peekPrevious() const
     \fn template <class T> const T &QVectorIterator<T>::peekPrevious() const
     \fn template <class T> const T &QSetIterator<T>::peekPrevious() const
-    \fn template <class T> const T &QMutableSetIterator<T>::peekPrevious() const
 
     Returns the previous item without moving the iterator.
 
@@ -832,6 +865,20 @@
     \sa hasPrevious(), previous(), peekNext()
 */
 
+/*!
+    \fn template <class T> bool QMutableSetIterator<T>::findNext(const T &value)
+    \obsolete Deprecated in order to align with std::unordered_set functionality.
+
+    Searches for \a value starting from the current iterator position
+    forward. Returns \c true if \a value is found; otherwise returns \c false.
+
+    After the call, if \a value was found, the iterator is positioned
+    just after the matching item; otherwise, the iterator is
+    positioned at the back of the container.
+
+    \sa findPrevious()
+*/
+
 /*! \fn template <class T> bool QListIterator<T>::findNext(const T &value)
     \fn template <class T> bool QLinkedListIterator<T>::findNext(const T &value)
     \fn template <class T> bool QVectorIterator<T>::findNext(const T &value)
@@ -839,7 +886,6 @@
     \fn template <class T> bool QMutableListIterator<T>::findNext(const T &value)
     \fn template <class T> bool QMutableLinkedListIterator<T>::findNext(const T &value)
     \fn template <class T> bool QMutableVectorIterator<T>::findNext(const T &value)
-    \fn template <class T> bool QMutableSetIterator<T>::findNext(const T &value)
 
     Searches for \a value starting from the current iterator position
     forward. Returns \c true if \a value is found; otherwise returns \c false.