diff options
author | Karsten Heimrich <karsten.heimrich@qt.io> | 2020-06-17 22:34:40 +0200 |
---|---|---|
committer | Karsten Heimrich <karsten.heimrich@qt.io> | 2020-06-18 14:45:54 +0200 |
commit | c1e5044d22367d9088329b796d383a0ae72a47bb (patch) | |
tree | ea31d4c8571b0a6d70618b747a87160f9d010cf0 /src/corelib/text | |
parent | 3ce2fab0a6bb9388522fa65d31b179c4d5a3f3f5 (diff) |
Fix QString{Encoder|Decoder} documentation
Change-Id: I8e29846db77581953d90c818060950744cb9f521
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Oliver Wolff <oliver.wolff@qt.io>
Diffstat (limited to 'src/corelib/text')
-rw-r--r-- | src/corelib/text/qstringconverter.cpp | 16 | ||||
-rw-r--r-- | src/corelib/text/qstringconverter.h | 8 |
2 files changed, 13 insertions, 11 deletions
diff --git a/src/corelib/text/qstringconverter.cpp b/src/corelib/text/qstringconverter.cpp index d1b3055bd4..2af1e5df27 100644 --- a/src/corelib/text/qstringconverter.cpp +++ b/src/corelib/text/qstringconverter.cpp @@ -1790,7 +1790,7 @@ const char *QStringConverter::nameForEncoding(QStringConverter::Encoding e) */ /*! - \fn QByteArray QStringEncoder::operator()(const QStringView in) + \fn QByteArray QStringEncoder::operator()(QStringView in) \overload Converts \a in and returns the data as a byte array. @@ -1884,23 +1884,25 @@ const char *QStringConverter::nameForEncoding(QStringConverter::Encoding e) */ /*! - \fn QByteArray QStringDecoder::operator()(const QString &in) + \fn QString QStringDecoder::operator()(const QByteArray &ba) - Converts \a in and returns the data as a QString. + Converts \a ba and returns the data as a QString. */ /*! - \fn QByteArray QStringDecoder::operator()(const QStringView in) + \fn QString QStringDecoder::operator()(const char *in, qsizetype size) \overload - Converts \a in and returns the data as a QString. + Converts a byte array containing the first \a size bytes of the array \a in + and returns the data as a QString. */ /*! - \fn QByteArray QStringDecoder::operator()(const QChar *in, qsizetype length) + \fn QString QStringDecoder::operator()(const char *chars) \overload - Converts \a length QChars from \a in and returns the data as a QString. + Converts \a chars and returns the data as a QString. \a chars is assumed to + point to a \c{\0}-terminated string and its length is determined dynamically. */ /*! diff --git a/src/corelib/text/qstringconverter.h b/src/corelib/text/qstringconverter.h index 2bbff666e8..0049b937af 100644 --- a/src/corelib/text/qstringconverter.h +++ b/src/corelib/text/qstringconverter.h @@ -207,9 +207,9 @@ public: {} #if defined(Q_QDOC) - QString operator()(const QString &); - QString operator()(QStringView); - QString operator()(const QChar *, qsizetype); + QByteArray operator()(const QString &in); + QByteArray operator()(QStringView in); + QByteArray operator()(const QChar *in, qsizetype length); #else template<typename T> struct DecodedData @@ -268,7 +268,7 @@ public: #if defined(Q_QDOC) QString operator()(const QByteArray &ba); - QString operator()(const char *in, qsizetype length); + QString operator()(const char *in, qsizetype size); QString operator()(const char *chars); #else template<typename T> |