diff options
author | Albert Astals Cid <albert.astals.cid@kdab.com> | 2020-06-05 17:09:29 +0200 |
---|---|---|
committer | Albert Astals Cid <albert.astals.cid@kdab.com> | 2020-06-09 15:26:00 +0200 |
commit | 20ba86262f39886629880fa1e07383f1e3e1d52e (patch) | |
tree | 2e158ec4acf06c5ef0f4637c23ab032875ab1eef /src | |
parent | d26a6e4a9250c9647289e1e62d4d0848c4f06b6f (diff) |
Add since markers for the Qt::endl, etc.
The Qt namespace was introduced in 461e89ee1a53f7669e0215f9015380c4a9d62371 which is only since 5.14
Also remove QTextStreamFunctions:: from the documentation of the
deprecated functions since the QTextStreamFunctions namespace is a syntaxic workaround.
Pick-to: 5.15
Change-Id: I9c15bcc49984bf5f5099c2f7df6b8adb3d2c61fb
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/corelib/serialization/qtextstream.cpp | 96 |
1 files changed, 72 insertions, 24 deletions
diff --git a/src/corelib/serialization/qtextstream.cpp b/src/corelib/serialization/qtextstream.cpp index 344eff56b2..5dd388c70c 100644 --- a/src/corelib/serialization/qtextstream.cpp +++ b/src/corelib/serialization/qtextstream.cpp @@ -2615,7 +2615,7 @@ QTextStream &QTextStream::operator<<(const void *ptr) namespace Qt { /*! - \fn QTextStream &QTextStreamFunctions::bin(QTextStream &stream) + \fn QTextStream &bin(QTextStream &stream) \relates QTextStream \obsolete Use Qt::bin() instead. */ @@ -2624,6 +2624,8 @@ namespace Qt { Calls QTextStream::setIntegerBase(2) on \a stream and returns \a stream. + \since 5.14 + \sa oct(), dec(), hex(), {QTextStream manipulators} */ QTextStream &bin(QTextStream &stream) @@ -2633,7 +2635,7 @@ QTextStream &bin(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::oct(QTextStream &stream) + \fn QTextStream &oct(QTextStream &stream) \relates QTextStream \obsolete Use Qt::oct() instead. */ @@ -2642,6 +2644,8 @@ QTextStream &bin(QTextStream &stream) Calls QTextStream::setIntegerBase(8) on \a stream and returns \a stream. + \since 5.14 + \sa bin(), dec(), hex(), {QTextStream manipulators} */ QTextStream &oct(QTextStream &stream) @@ -2651,7 +2655,7 @@ QTextStream &oct(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::dec(QTextStream &stream) + \fn QTextStream &dec(QTextStream &stream) \relates QTextStream \obsolete Use Qt::dec() instead. */ @@ -2660,6 +2664,8 @@ QTextStream &oct(QTextStream &stream) Calls QTextStream::setIntegerBase(10) on \a stream and returns \a stream. + \since 5.14 + \sa bin(), oct(), hex(), {QTextStream manipulators} */ QTextStream &dec(QTextStream &stream) @@ -2669,7 +2675,7 @@ QTextStream &dec(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::hex(QTextStream &stream) + \fn QTextStream &hex(QTextStream &stream) \relates QTextStream \obsolete Use Qt::hex() instead. */ @@ -2678,6 +2684,8 @@ QTextStream &dec(QTextStream &stream) Calls QTextStream::setIntegerBase(16) on \a stream and returns \a stream. + \since 5.14 + \note The hex modifier can only be used for writing to streams. \sa bin(), oct(), dec(), {QTextStream manipulators} */ @@ -2688,7 +2696,7 @@ QTextStream &hex(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::showbase(QTextStream &stream) + \fn QTextStream &showbase(QTextStream &stream) \relates QTextStream \obsolete Use Qt::showbase() instead. */ @@ -2697,6 +2705,8 @@ QTextStream &hex(QTextStream &stream) Calls QTextStream::setNumberFlags(QTextStream::numberFlags() | QTextStream::ShowBase) on \a stream and returns \a stream. + \since 5.14 + \sa noshowbase(), forcesign(), forcepoint(), {QTextStream manipulators} */ QTextStream &showbase(QTextStream &stream) @@ -2706,7 +2716,7 @@ QTextStream &showbase(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::forcesign(QTextStream &stream) + \fn QTextStream &forcesign(QTextStream &stream) \relates QTextStream \obsolete Use Qt::forcesign() instead. */ @@ -2715,6 +2725,8 @@ QTextStream &showbase(QTextStream &stream) Calls QTextStream::setNumberFlags(QTextStream::numberFlags() | QTextStream::ForceSign) on \a stream and returns \a stream. + \since 5.14 + \sa noforcesign(), forcepoint(), showbase(), {QTextStream manipulators} */ QTextStream &forcesign(QTextStream &stream) @@ -2724,7 +2736,7 @@ QTextStream &forcesign(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::forcepoint(QTextStream &stream) + \fn QTextStream &forcepoint(QTextStream &stream) \relates QTextStream \obsolete Use Qt::forcepoint() instead. */ @@ -2733,6 +2745,8 @@ QTextStream &forcesign(QTextStream &stream) Calls QTextStream::setNumberFlags(QTextStream::numberFlags() | QTextStream::ForcePoint) on \a stream and returns \a stream. + \since 5.14 + \sa noforcepoint(), forcesign(), showbase(), {QTextStream manipulators} */ QTextStream &forcepoint(QTextStream &stream) @@ -2742,7 +2756,7 @@ QTextStream &forcepoint(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::noshowbase(QTextStream &stream) + \fn QTextStream &noshowbase(QTextStream &stream) \relates QTextStream \obsolete Use Qt::noshowbase() instead. */ @@ -2751,6 +2765,8 @@ QTextStream &forcepoint(QTextStream &stream) Calls QTextStream::setNumberFlags(QTextStream::numberFlags() & ~QTextStream::ShowBase) on \a stream and returns \a stream. + \since 5.14 + \sa showbase(), noforcesign(), noforcepoint(), {QTextStream manipulators} */ QTextStream &noshowbase(QTextStream &stream) @@ -2760,7 +2776,7 @@ QTextStream &noshowbase(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::noforcesign(QTextStream &stream) + \fn QTextStream &noforcesign(QTextStream &stream) \relates QTextStream \obsolete Use Qt::noforcesign() instead. */ @@ -2769,6 +2785,8 @@ QTextStream &noshowbase(QTextStream &stream) Calls QTextStream::setNumberFlags(QTextStream::numberFlags() & ~QTextStream::ForceSign) on \a stream and returns \a stream. + \since 5.14 + \sa forcesign(), noforcepoint(), noshowbase(), {QTextStream manipulators} */ QTextStream &noforcesign(QTextStream &stream) @@ -2778,7 +2796,7 @@ QTextStream &noforcesign(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::noforcepoint(QTextStream &stream) + \fn QTextStream &noforcepoint(QTextStream &stream) \relates QTextStream \obsolete Use Qt::noforcepoint() instead. */ @@ -2787,6 +2805,8 @@ QTextStream &noforcesign(QTextStream &stream) Calls QTextStream::setNumberFlags(QTextStream::numberFlags() & ~QTextStream::ForcePoint) on \a stream and returns \a stream. + \since 5.14 + \sa forcepoint(), noforcesign(), noshowbase(), {QTextStream manipulators} */ QTextStream &noforcepoint(QTextStream &stream) @@ -2796,7 +2816,7 @@ QTextStream &noforcepoint(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::uppercasebase(QTextStream &stream) + \fn QTextStream &uppercasebase(QTextStream &stream) \relates QTextStream \obsolete Use Qt::uppercasebase() instead. */ @@ -2805,6 +2825,8 @@ QTextStream &noforcepoint(QTextStream &stream) Calls QTextStream::setNumberFlags(QTextStream::numberFlags() | QTextStream::UppercaseBase) on \a stream and returns \a stream. + \since 5.14 + \sa lowercasebase(), uppercasedigits(), {QTextStream manipulators} */ QTextStream &uppercasebase(QTextStream &stream) @@ -2814,7 +2836,7 @@ QTextStream &uppercasebase(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::uppercasedigits(QTextStream &stream) + \fn QTextStream &uppercasedigits(QTextStream &stream) \relates QTextStream \obsolete Use Qt::uppercasedigits() instead. */ @@ -2823,6 +2845,8 @@ QTextStream &uppercasebase(QTextStream &stream) Calls QTextStream::setNumberFlags(QTextStream::numberFlags() | QTextStream::UppercaseDigits) on \a stream and returns \a stream. + \since 5.14 + \sa lowercasedigits(), uppercasebase(), {QTextStream manipulators} */ QTextStream &uppercasedigits(QTextStream &stream) @@ -2832,7 +2856,7 @@ QTextStream &uppercasedigits(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::lowercasebase(QTextStream &stream) + \fn QTextStream &lowercasebase(QTextStream &stream) \relates QTextStream \obsolete Use Qt::lowercasebase() instead. */ @@ -2841,6 +2865,8 @@ QTextStream &uppercasedigits(QTextStream &stream) Calls QTextStream::setNumberFlags(QTextStream::numberFlags() & ~QTextStream::UppercaseBase) on \a stream and returns \a stream. + \since 5.14 + \sa uppercasebase(), lowercasedigits(), {QTextStream manipulators} */ QTextStream &lowercasebase(QTextStream &stream) @@ -2850,7 +2876,7 @@ QTextStream &lowercasebase(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::lowercasedigits(QTextStream &stream) + \fn QTextStream &lowercasedigits(QTextStream &stream) \relates QTextStream \obsolete Use Qt::lowercasedigits() instead. */ @@ -2859,6 +2885,8 @@ QTextStream &lowercasebase(QTextStream &stream) Calls QTextStream::setNumberFlags(QTextStream::numberFlags() & ~QTextStream::UppercaseDigits) on \a stream and returns \a stream. + \since 5.14 + \sa uppercasedigits(), lowercasebase(), {QTextStream manipulators} */ QTextStream &lowercasedigits(QTextStream &stream) @@ -2868,7 +2896,7 @@ QTextStream &lowercasedigits(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::fixed(QTextStream &stream) + \fn QTextStream &fixed(QTextStream &stream) \relates QTextStream \obsolete Use Qt::fixed() instead. */ @@ -2877,6 +2905,8 @@ QTextStream &lowercasedigits(QTextStream &stream) Calls QTextStream::setRealNumberNotation(QTextStream::FixedNotation) on \a stream and returns \a stream. + \since 5.14 + \sa scientific(), {QTextStream manipulators} */ QTextStream &fixed(QTextStream &stream) @@ -2886,7 +2916,7 @@ QTextStream &fixed(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::scientific(QTextStream &stream) + \fn QTextStream &scientific(QTextStream &stream) \relates QTextStream \obsolete Use Qt::scientific() instead. */ @@ -2895,6 +2925,8 @@ QTextStream &fixed(QTextStream &stream) Calls QTextStream::setRealNumberNotation(QTextStream::ScientificNotation) on \a stream and returns \a stream. + \since 5.14 + \sa fixed(), {QTextStream manipulators} */ QTextStream &scientific(QTextStream &stream) @@ -2904,7 +2936,7 @@ QTextStream &scientific(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::left(QTextStream &stream) + \fn QTextStream &left(QTextStream &stream) \relates QTextStream \obsolete Use Qt::left() instead. */ @@ -2913,6 +2945,8 @@ QTextStream &scientific(QTextStream &stream) Calls QTextStream::setFieldAlignment(QTextStream::AlignLeft) on \a stream and returns \a stream. + \since 5.14 + \sa {QTextStream::}{right()}, {QTextStream::}{center()}, {QTextStream manipulators} */ QTextStream &left(QTextStream &stream) @@ -2922,7 +2956,7 @@ QTextStream &left(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::right(QTextStream &stream) + \fn QTextStream &right(QTextStream &stream) \relates QTextStream \obsolete Use Qt::right() instead. */ @@ -2931,6 +2965,8 @@ QTextStream &left(QTextStream &stream) Calls QTextStream::setFieldAlignment(QTextStream::AlignRight) on \a stream and returns \a stream. + \since 5.14 + \sa {QTextStream::}{left()}, {QTextStream::}{center()}, {QTextStream manipulators} */ QTextStream &right(QTextStream &stream) @@ -2940,7 +2976,7 @@ QTextStream &right(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::center(QTextStream &stream) + \fn QTextStream ¢er(QTextStream &stream) \relates QTextStream \obsolete Use Qt::center() instead. */ @@ -2949,6 +2985,8 @@ QTextStream &right(QTextStream &stream) Calls QTextStream::setFieldAlignment(QTextStream::AlignCenter) on \a stream and returns \a stream. + \since 5.14 + \sa {QTextStream::}{left()}, {QTextStream::}{right()}, {QTextStream manipulators} */ QTextStream ¢er(QTextStream &stream) @@ -2958,7 +2996,7 @@ QTextStream ¢er(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::endl(QTextStream &stream) + \fn QTextStream &endl(QTextStream &stream) \relates QTextStream \obsolete Use Qt::endl() instead. */ @@ -2973,6 +3011,8 @@ QTextStream ¢er(QTextStream &stream) Note: On Windows, all '\\n' characters are written as '\\r\\n' if QTextStream's device or string is opened using the QIODevice::Text flag. + \since 5.14 + \sa flush(), reset(), {QTextStream manipulators} */ QTextStream &endl(QTextStream &stream) @@ -2981,7 +3021,7 @@ QTextStream &endl(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::flush(QTextStream &stream) + \fn QTextStream &flush(QTextStream &stream) \relates QTextStream \obsolete Use Qt::flush() instead. */ @@ -2989,6 +3029,8 @@ QTextStream &endl(QTextStream &stream) /*! Calls QTextStream::flush() on \a stream and returns \a stream. + \since 5.14 + \sa endl(), reset(), {QTextStream manipulators} */ QTextStream &flush(QTextStream &stream) @@ -2998,7 +3040,7 @@ QTextStream &flush(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::reset(QTextStream &stream) + \fn QTextStream &reset(QTextStream &stream) \relates QTextStream \obsolete Use Qt::reset() instead. */ @@ -3006,6 +3048,8 @@ QTextStream &flush(QTextStream &stream) /*! Calls QTextStream::reset() on \a stream and returns \a stream. + \since 5.14 + \sa flush(), {QTextStream manipulators} */ QTextStream &reset(QTextStream &stream) @@ -3015,7 +3059,7 @@ QTextStream &reset(QTextStream &stream) } /*! - \fn QTextStream &QTextStreamFunctions::ws(QTextStream &stream) + \fn QTextStream &ws(QTextStream &stream) \relates QTextStream \obsolete Use Qt::ws() instead. */ @@ -3023,6 +3067,8 @@ QTextStream &reset(QTextStream &stream) /*! Calls \l {QTextStream::}{skipWhiteSpace()} on \a stream and returns \a stream. + \since 5.14 + \sa {QTextStream manipulators} */ QTextStream &ws(QTextStream &stream) @@ -3057,7 +3103,7 @@ QTextStream &ws(QTextStream &stream) namespace Qt { /*! - \fn QTextStream &QTextStreamFunctions::bom(QTextStream &stream) + \fn QTextStream &bom(QTextStream &stream) \relates QTextStream \obsolete Use Qt::bom() instead. */ @@ -3066,6 +3112,8 @@ namespace Qt { Toggles insertion of the Byte Order Mark on \a stream when QTextStream is used with a UTF encoding. + \since 5.14 + \sa QTextStream::setGenerateByteOrderMark(), {QTextStream manipulators} */ QTextStream &bom(QTextStream &stream) |