Doc: Improve deprecation messages for functions using QString::SplitBehavior

Directly link to the recommended replacement.

Inspired by forum.qt.io discussion:

https://forum.qt.io/topic/125277/multiple-warning-messages-when-using-split-in-qt-5-15-2

Change-Id: Id880e892b90b6e37bc4f7888968a490b634785ce
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>

2 files changed, 21 insertions, 8 deletions

diff --git a/src/corelib/text/qstring.cpp b/src/corelib/text/qstring.cpp
index a133f98a17..6095551738 100644
--- a/src/corelib/text/qstring.cpp
+++ b/src/corelib/text/qstring.cpp
@@ -7872,6 +7872,8 @@ QStringList QString::split(const QString &sep, Qt::SplitBehavior behavior, Qt::C
 #if QT_DEPRECATED_SINCE(5, 15)
 /*!
     \overload
+    Use QString::split(const QString &sep, Qt::SplitBehavior behavior, Qt::CaseSensitivity cs) instead.
+
     \obsolete
 */
 QStringList QString::split(const QString &sep, SplitBehavior behavior, Qt::CaseSensitivity cs) const
@@ -7904,6 +7906,8 @@ QVector<QStringRef> QString::splitRef(const QString &sep, Qt::SplitBehavior beha
 /*!
     \overload
     \obsolete
+    Use QString::splitRef(const QString &sep, Qt::SplitBehavior behavior, Qt::CaseSensitivity cs) instead.
+
     \since 5.4
 */
 QVector<QStringRef> QString::splitRef(const QString &sep, SplitBehavior behavior, Qt::CaseSensitivity cs) const
@@ -7925,6 +7929,8 @@ QStringList QString::split(QChar sep, Qt::SplitBehavior behavior, Qt::CaseSensit
 /*!
     \overload
     \obsolete
+    Use QString::split(QChar sep, Qt::SplitBehavior behavior, Qt::CaseSensitivity cs) instead.
+
 */
 QStringList QString::split(QChar sep, SplitBehavior behavior, Qt::CaseSensitivity cs) const
 {
@@ -7975,6 +7981,7 @@ QVector<QStringRef> QStringRef::split(const QString &sep, Qt::SplitBehavior beha
     \overload
     \since 5.4
     \obsolete
+    Use QString::split(const QString &sep, Qt::SplitBehavior behavior, Qt::CaseSensitivity cs) instead.
 */
 QVector<QStringRef> QStringRef::split(const QString &sep, QString::SplitBehavior behavior, Qt::CaseSensitivity cs) const
 {
@@ -7996,6 +8003,7 @@ QVector<QStringRef> QStringRef::split(QChar sep, Qt::SplitBehavior behavior, Qt:
     \overload
     \since 5.4
     \obsolete
+    Use QString::split(QChar sep, Qt::SplitBehavior behavior, Qt::CaseSensitivity cs) instead.
 */
 QVector<QStringRef> QStringRef::split(QChar sep, QString::SplitBehavior behavior, Qt::CaseSensitivity cs) const
 {
@@ -8062,6 +8070,7 @@ QStringList QString::split(const QRegExp &rx, Qt::SplitBehavior behavior) const
 /*!
     \overload
     \obsolete
+    Use QString::split(const QRegularExpression &sep, Qt::SplitBehavior behavior) instead.
 */
 QStringList QString::split(const QRegExp &rx, SplitBehavior behavior) const
 {
@@ -8093,6 +8102,7 @@ QVector<QStringRef> QString::splitRef(const QRegExp &rx, Qt::SplitBehavior behav
     \overload
     \since 5.4
     \obsolete
+    Use QString::splitRef(const QRegularExpression &sep, Qt::SplitBehavior behavior) instead.
 */
 QVector<QStringRef> QString::splitRef(const QRegExp &rx, SplitBehavior behavior) const
 {
@@ -8168,6 +8178,7 @@ QStringList QString::split(const QRegularExpression &re, Qt::SplitBehavior behav
     \overload
     \since 5.0
     \obsolete
+    Use QString::split(const QRegularExpression &sep, Qt::SplitBehavior behavior) instead.
 */
 QStringList QString::split(const QRegularExpression &re, SplitBehavior behavior) const
 {
@@ -8199,6 +8210,8 @@ QVector<QStringRef> QString::splitRef(const QRegularExpression &re, Qt::SplitBeh
     \overload
     \since 5.4
     \obsolete
+    Use QString::splitRef(const QRegularExpression &sep, Qt::SplitBehavior behavior) instead.
+
 */
 QVector<QStringRef> QString::splitRef(const QRegularExpression &re, SplitBehavior behavior) const
 {
diff --git a/src/corelib/text/qstring.h b/src/corelib/text/qstring.h
index ecc583fa8e..6c365f1b0c 100644
--- a/src/corelib/text/qstring.h
+++ b/src/corelib/text/qstring.h
@@ -605,28 +605,28 @@ public:
         SkipEmptyParts Q_DECL_ENUMERATOR_DEPRECATED
     };
 
-    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use Qt::SplitBehavior variant instead")
+    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use split(const QString &sep, Qt::SplitBehavior ...) variant instead")
     QStringList split(const QString &sep, SplitBehavior behavior,
                                         Qt::CaseSensitivity cs = Qt::CaseSensitive) const;
-    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use Qt::SplitBehavior variant instead")
+    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use splitRef(const QString &sep, Qt::SplitBehavior ...) variant instead")
     QVector<QStringRef> splitRef(const QString &sep, SplitBehavior behavior,
                                                    Qt::CaseSensitivity cs = Qt::CaseSensitive) const;
-    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use Qt::SplitBehavior variant instead")
+    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use split(QChar sep, Qt::SplitBehavior ...) variant instead")
     QStringList split(QChar sep, SplitBehavior behavior,
                                         Qt::CaseSensitivity cs = Qt::CaseSensitive) const;
-    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use Qt::SplitBehavior variant instead")
+    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use splitRef(QChar sep, Qt::SplitBehavior ...) variant instead")
     QVector<QStringRef> splitRef(QChar sep, SplitBehavior behavior,
                                                    Qt::CaseSensitivity cs = Qt::CaseSensitive) const;
 #ifndef QT_NO_REGEXP
-    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use Qt::SplitBehavior variant instead")
+    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use split(const QRegularExpression &, Qt::SplitBehavior) variant instead")
     QStringList split(const QRegExp &sep, SplitBehavior behavior) const;
-    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use Qt::SplitBehavior variant instead")
+    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use splitRef(const QRegularExpression &, Qt::SplitBehavior) variant instead")
     QVector<QStringRef> splitRef(const QRegExp &sep, SplitBehavior behavior) const;
 #endif
 #if QT_CONFIG(regularexpression)
-    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use Qt::SplitBehavior variant instead")
+    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use split(const QRegularExpression &, Qt::SplitBehavior) variant instead")
     QStringList split(const QRegularExpression &sep, SplitBehavior behavior) const;
-    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use Qt::SplitBehavior variant instead")
+    Q_REQUIRED_RESULT QT_DEPRECATED_VERSION_X_5_15("Use splitRef(const QRegularExpression &, Qt::SplitBehavior) variant instead")
     QVector<QStringRef> splitRef(const QRegularExpression &sep, SplitBehavior behavior) const;
 #endif
 #endif // 5.15 deprecations