Doc: Fix various documentation warnings

QDoc now qualifies the scope of \fn arguments with the namespace the
documentation comment appears in; move the comments that do not
relate to the Qt namespace away from the namespace scope.

Fix linking to Qt Designer manual.

Change-Id: I84f71a16bc65a408bd92384bb337a99a43d1c91d
Reviewed-by: Paul Wicking <paul.wicking@qt.io>

1 files changed, 139 insertions, 140 deletions

diff --git a/src/corelib/serialization/qtextstream.cpp b/src/corelib/serialization/qtextstream.cpp
index 3bb00d967a..36afd107d8 100644
--- a/src/corelib/serialization/qtextstream.cpp
+++ b/src/corelib/serialization/qtextstream.cpp
@@ -2690,8 +2690,6 @@ QTextStream &QTextStream::operator<<(const void *ptr)
     return *this;
 }
 
-namespace Qt {
-
 /*!
     \fn QTextStream &bin(QTextStream &stream)
     \relates QTextStream
@@ -2699,6 +2697,140 @@ namespace Qt {
 */
 
 /*!
+    \fn QTextStream &oct(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::oct() instead.
+*/
+
+/*!
+    \fn QTextStream &dec(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::dec() instead.
+*/
+
+/*!
+    \fn QTextStream &hex(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::hex() instead.
+*/
+
+/*!
+    \fn QTextStream &showbase(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::showbase() instead.
+*/
+
+/*!
+    \fn QTextStream &forcesign(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::forcesign() instead.
+*/
+
+/*!
+    \fn QTextStream &forcepoint(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::forcepoint() instead.
+*/
+
+/*!
+    \fn QTextStream &noshowbase(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::noshowbase() instead.
+*/
+
+/*!
+    \fn QTextStream &noforcesign(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::noforcesign() instead.
+*/
+
+/*!
+    \fn QTextStream &noforcepoint(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::noforcepoint() instead.
+*/
+
+/*!
+    \fn QTextStream &uppercasebase(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::uppercasebase() instead.
+*/
+
+/*!
+    \fn QTextStream &uppercasedigits(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::uppercasedigits() instead.
+*/
+
+/*!
+    \fn QTextStream &lowercasebase(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::lowercasebase() instead.
+*/
+
+/*!
+    \fn QTextStream &lowercasedigits(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::lowercasedigits() instead.
+*/
+
+/*!
+    \fn QTextStream &fixed(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::fixed() instead.
+*/
+
+/*!
+    \fn QTextStream &scientific(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::scientific() instead.
+*/
+
+/*!
+    \fn QTextStream &left(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::left() instead.
+*/
+
+/*!
+    \fn QTextStream &right(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::right() instead.
+*/
+
+/*!
+    \fn QTextStream &center(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::center() instead.
+*/
+
+/*!
+    \fn QTextStream &endl(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::endl() instead.
+*/
+
+/*!
+    \fn QTextStream &flush(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::flush() instead.
+*/
+
+/*!
+    \fn QTextStream &reset(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::reset() instead.
+*/
+
+/*!
+    \fn QTextStream &ws(QTextStream &stream)
+    \relates QTextStream
+    \obsolete Use Qt::ws() instead.
+*/
+
+namespace Qt {
+
+/*!
     Calls QTextStream::setIntegerBase(2) on \a stream and returns \a
     stream.
 
@@ -2713,12 +2845,6 @@ QTextStream &bin(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &oct(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::oct() instead.
-*/
-
-/*!
     Calls QTextStream::setIntegerBase(8) on \a stream and returns \a
     stream.
 
@@ -2733,12 +2859,6 @@ QTextStream &oct(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &dec(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::dec() instead.
-*/
-
-/*!
     Calls QTextStream::setIntegerBase(10) on \a stream and returns \a
     stream.
 
@@ -2753,12 +2873,6 @@ QTextStream &dec(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &hex(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::hex() instead.
-*/
-
-/*!
     Calls QTextStream::setIntegerBase(16) on \a stream and returns \a
     stream.
 
@@ -2774,12 +2888,6 @@ QTextStream &hex(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &showbase(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::showbase() instead.
-*/
-
-/*!
     Calls QTextStream::setNumberFlags(QTextStream::numberFlags() |
     QTextStream::ShowBase) on \a stream and returns \a stream.
 
@@ -2794,12 +2902,6 @@ QTextStream &showbase(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &forcesign(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::forcesign() instead.
-*/
-
-/*!
     Calls QTextStream::setNumberFlags(QTextStream::numberFlags() |
     QTextStream::ForceSign) on \a stream and returns \a stream.
 
@@ -2814,12 +2916,6 @@ QTextStream &forcesign(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &forcepoint(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::forcepoint() instead.
-*/
-
-/*!
     Calls QTextStream::setNumberFlags(QTextStream::numberFlags() |
     QTextStream::ForcePoint) on \a stream and returns \a stream.
 
@@ -2834,12 +2930,6 @@ QTextStream &forcepoint(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &noshowbase(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::noshowbase() instead.
-*/
-
-/*!
     Calls QTextStream::setNumberFlags(QTextStream::numberFlags() &
     ~QTextStream::ShowBase) on \a stream and returns \a stream.
 
@@ -2854,12 +2944,6 @@ QTextStream &noshowbase(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &noforcesign(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::noforcesign() instead.
-*/
-
-/*!
     Calls QTextStream::setNumberFlags(QTextStream::numberFlags() &
     ~QTextStream::ForceSign) on \a stream and returns \a stream.
 
@@ -2874,12 +2958,6 @@ QTextStream &noforcesign(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &noforcepoint(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::noforcepoint() instead.
-*/
-
-/*!
     Calls QTextStream::setNumberFlags(QTextStream::numberFlags() &
     ~QTextStream::ForcePoint) on \a stream and returns \a stream.
 
@@ -2894,12 +2972,6 @@ QTextStream &noforcepoint(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &uppercasebase(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::uppercasebase() instead.
-*/
-
-/*!
     Calls QTextStream::setNumberFlags(QTextStream::numberFlags() |
     QTextStream::UppercaseBase) on \a stream and returns \a stream.
 
@@ -2914,12 +2986,6 @@ QTextStream &uppercasebase(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &uppercasedigits(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::uppercasedigits() instead.
-*/
-
-/*!
     Calls QTextStream::setNumberFlags(QTextStream::numberFlags() |
     QTextStream::UppercaseDigits) on \a stream and returns \a stream.
 
@@ -2934,12 +3000,6 @@ QTextStream &uppercasedigits(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &lowercasebase(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::lowercasebase() instead.
-*/
-
-/*!
     Calls QTextStream::setNumberFlags(QTextStream::numberFlags() &
     ~QTextStream::UppercaseBase) on \a stream and returns \a stream.
 
@@ -2954,12 +3014,6 @@ QTextStream &lowercasebase(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &lowercasedigits(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::lowercasedigits() instead.
-*/
-
-/*!
     Calls QTextStream::setNumberFlags(QTextStream::numberFlags() &
     ~QTextStream::UppercaseDigits) on \a stream and returns \a stream.
 
@@ -2974,12 +3028,6 @@ QTextStream &lowercasedigits(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &fixed(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::fixed() instead.
-*/
-
-/*!
     Calls QTextStream::setRealNumberNotation(QTextStream::FixedNotation)
     on \a stream and returns \a stream.
 
@@ -2994,12 +3042,6 @@ QTextStream &fixed(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &scientific(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::scientific() instead.
-*/
-
-/*!
     Calls QTextStream::setRealNumberNotation(QTextStream::ScientificNotation)
     on \a stream and returns \a stream.
 
@@ -3014,18 +3056,12 @@ QTextStream &scientific(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &left(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::left() instead.
-*/
-
-/*!
     Calls QTextStream::setFieldAlignment(QTextStream::AlignLeft)
     on \a stream and returns \a stream.
 
     \since 5.14
 
-    \sa {QTextStream::}{right()}, {QTextStream::}{center()}, {QTextStream manipulators}
+    \sa right(), center(), {QTextStream manipulators}
 */
 QTextStream &left(QTextStream &stream)
 {
@@ -3034,18 +3070,12 @@ QTextStream &left(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &right(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::right() instead.
-*/
-
-/*!
     Calls QTextStream::setFieldAlignment(QTextStream::AlignRight)
     on \a stream and returns \a stream.
 
     \since 5.14
 
-    \sa {QTextStream::}{left()}, {QTextStream::}{center()}, {QTextStream manipulators}
+    \sa left(), center(), {QTextStream manipulators}
 */
 QTextStream &right(QTextStream &stream)
 {
@@ -3054,18 +3084,12 @@ QTextStream &right(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &center(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::center() instead.
-*/
-
-/*!
     Calls QTextStream::setFieldAlignment(QTextStream::AlignCenter)
     on \a stream and returns \a stream.
 
     \since 5.14
 
-    \sa {QTextStream::}{left()}, {QTextStream::}{right()}, {QTextStream manipulators}
+    \sa left(), right(), {QTextStream manipulators}
 */
 QTextStream &center(QTextStream &stream)
 {
@@ -3074,12 +3098,6 @@ QTextStream &center(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &endl(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::endl() instead.
-*/
-
-/*!
     Writes '\\n' to the \a stream and flushes the stream.
 
     Equivalent to
@@ -3099,12 +3117,6 @@ QTextStream &endl(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &flush(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::flush() instead.
-*/
-
-/*!
     Calls QTextStream::flush() on \a stream and returns \a stream.
 
     \since 5.14
@@ -3118,12 +3130,6 @@ QTextStream &flush(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &reset(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::reset() instead.
-*/
-
-/*!
     Calls QTextStream::reset() on \a stream and returns \a stream.
 
     \since 5.14
@@ -3137,12 +3143,6 @@ QTextStream &reset(QTextStream &stream)
 }
 
 /*!
-    \fn QTextStream &ws(QTextStream &stream)
-    \relates QTextStream
-    \obsolete Use Qt::ws() instead.
-*/
-
-/*!
     Calls \l {QTextStream::}{skipWhiteSpace()} on \a stream and returns \a stream.
 
     \since 5.14
@@ -3179,14 +3179,13 @@ QTextStream &ws(QTextStream &stream)
 */
 
 #if QT_CONFIG(textcodec)
-
-namespace Qt {
 /*!
     \fn QTextStream &bom(QTextStream &stream)
     \relates QTextStream
     \obsolete Use Qt::bom() instead.
 */
 
+namespace Qt {
 /*!
     Toggles insertion of the Byte Order Mark on \a stream when QTextStream is
     used with a UTF codec.
@@ -3297,7 +3296,7 @@ bool QTextStream::autoDetectUnicode() const
     device. If \a generate is false, no BOM will be inserted. This function
     must be called before any data is written. Otherwise, it does nothing.
 
-    \sa generateByteOrderMark(), bom()
+    \sa generateByteOrderMark(), {Qt::}{bom()}
 */
 void QTextStream::setGenerateByteOrderMark(bool generate)
 {