From e5ad0e76839331f0b2b2e2592168234df7548f20 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Kai=20K=C3=B6hne?= <kai.koehne@qt.io>
Date: Thu, 15 Apr 2021 12:42:22 +0200
Subject: Doc: Mark QSet::toList, QSet::fromList, QList::toSet, QList::fromSet
 as obsolete

They got deprecated in code already in 92f98427326. Make sure they
are marked as deprecated in the documenation, too, and give examples
on what to use instead.

Change-Id: I003020a44cbc6187dc813796c7f93f9f9d93bf0b
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
---
 src/corelib/tools/qlist.cpp | 68 ++++++++++++++++++++++++++++++++-------------
 1 file changed, 49 insertions(+), 19 deletions(-)

(limited to 'src/corelib/tools/qlist.cpp')

diff --git a/src/corelib/tools/qlist.cpp b/src/corelib/tools/qlist.cpp
index c0b0912249..eb5a06bb33 100644
--- a/src/corelib/tools/qlist.cpp
+++ b/src/corelib/tools/qlist.cpp
@@ -2017,7 +2017,7 @@ void **QListData::erase(void **xi)
 
     \include containers-range-constructor.qdocinc
 
-    \sa fromSet(), toVector(), QVector::toList()
+    \sa toVector(), QVector::toList()
 */
 
 /*! \fn template <class T> QVector<T> QList<T>::toVector() const
@@ -2030,61 +2030,91 @@ void **QListData::erase(void **xi)
 
     \include containers-range-constructor.qdocinc
 
-    \sa toSet(), fromVector(), QVector::fromList()
+    \sa  fromVector(), QVector::fromList()
 */
 
 /*! \fn template <class T> QList<T> QList<T>::fromSet(const QSet<T> &set)
+    \obsolete
 
     Returns a QList object with the data contained in \a set. The
     order of the elements in the QList is undefined.
 
-    Example:
-
-    \snippet code/src_corelib_tools_qlistdata.cpp 23
-
     \include containers-range-constructor.qdocinc
 
-    \sa fromVector(), toSet(), QSet::toList()
+    \oldcode
+    QSet<int> set;
+    // ...
+    QList<int> list = QList<int>::fromSet(set);
+    \newcode
+    QSet<int> set;
+    // ...
+    QList<int> list(set.begin(), set.end());
+    \endcode
+
+    \sa QList(InputIterator, InputIterator), fromVector(), toSet(), QSet::toList()
 */
 
 /*! \fn template <class T> QSet<T> QList<T>::toSet() const
+    \obsolete
 
     Returns a QSet object with the data contained in this QList.
     Since QSet doesn't allow duplicates, the resulting QSet might be
     smaller than the original list was.
 
-    Example:
-
-    \snippet code/src_corelib_tools_qlistdata.cpp 24
-
     \include containers-range-constructor.qdocinc
 
-    \sa toVector(), fromSet(), QSet::fromList()
+    \oldcode
+    QStringList list;
+    // ...
+    QSet<QString> set = list.toSet();
+    \newcode
+    QStringList list;
+    // ...
+    QSet<QString> set(list.begin(), list.end());
+    \endcode
+
+    \sa QSet::QSet(InputIterator, InputIterator), toVector(), fromSet(), QSet::fromList()
 */
 
 /*! \fn template <class T> QList<T> QList<T>::fromStdList(const std::list<T> &list)
+    \obsolete
 
     Returns a QList object with the data contained in \a list. The
     order of the elements in the QList is the same as in \a list.
 
-    Example:
-
-    \snippet code/src_corelib_tools_qlistdata.cpp 25
-
     \include containers-range-constructor.qdocinc
 
-    \sa toStdList(), QVector::fromStdVector()
+    \oldcode
+    std::list<double> stdlist;
+    // ...
+    QList<double> list = QList<double>::fromStdList(stdlist);
+    \newcode
+    std::list<double> stdlist;
+    // ...
+    QList<double> list(stdlist.begin(), stdlist.end());
+    \endcode
+
+    \sa QList(InputIterator, InputIterator), toStdList(), QVector::fromStdVector()
 */
 
 /*! \fn template <class T> std::list<T> QList<T>::toStdList() const
+    \obsolete
 
     Returns a std::list object with the data contained in this QList.
     Example:
 
-    \snippet code/src_corelib_tools_qlistdata.cpp 26
-
     \include containers-range-constructor.qdocinc
 
+    \oldcode
+    QList<double> list;
+    // ...
+    std::list<double> stdlist = list.toStdList();
+    \newcode
+    QList<double> list;
+    // ...
+    std::list<double> stdlist(list.begin(), list.end());
+    \endcode
+
     \sa fromStdList(), QVector::toStdVector()
 */
 
-- 
cgit v1.2.3