diff options
| author | Thiago Macieira <thiago.macieira@intel.com> | 2018-05-29 20:26:17 -0700 |
|---|---|---|
| committer | Thiago Macieira <thiago.macieira@intel.com> | 2018-07-04 03:04:47 +0000 |
| commit | 222e85d43431aa4c4e04f6ea4e942baf23a26cb5 (patch) | |
| tree | 6f859c6427fc165c069b51cd1f13fe7320a3ea4f /src/corelib/global/qendian.cpp | |
| parent | e79b56e50474f67044565361ef622a10eaad76ed (diff) | |
Doc: Fix list of which types are allowed in the endian functions
This commit also fixes a grammar mistake (endian → endianness) and the
fact that some functions failed to list that they supported the unsigned
integer types as template arguments.
Change-Id: I19445f335e82420fa654fffd15334e52ef3e744d
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io>
Diffstat (limited to 'src/corelib/global/qendian.cpp')
| -rw-r--r-- | src/corelib/global/qendian.cpp | 22 |
1 files changed, 14 insertions, 8 deletions
diff --git a/src/corelib/global/qendian.cpp b/src/corelib/global/qendian.cpp index ec6bfec60e..5bc5507dd5 100644 --- a/src/corelib/global/qendian.cpp +++ b/src/corelib/global/qendian.cpp @@ -86,8 +86,9 @@ QT_BEGIN_NAMESPACE On CPU architectures where the host byte order is little-endian (such as x86) this will swap the byte order; otherwise it will just read from \a src. - \note Template type \c{T} can either be a qint16, qint32 or qint64. Other types of - integers, e.g., qlong, are not applicable. + \note Template type \c{T} can either be a quint16, qint16, quint32, qint32, + quint64, or qint64. Other types of integers, e.g., qlong, are not + applicable. \note Since Qt 5.7, the type of the \a src parameter is a void pointer. @@ -145,8 +146,9 @@ QT_BEGIN_NAMESPACE On CPU architectures where the host byte order is big-endian (such as PowerPC) this will swap the byte order; otherwise it will just read from \a src. - \note Template type \c{T} can either be a qint16, qint32 or qint64. Other types of - integers, e.g., qlong, are not applicable. + \note Template type \c{T} can either be a quint16, qint16, quint32, qint32, + quint64, or qint64. Other types of integers, e.g., qlong, are not + applicable. \note Since Qt 5.7, the type of the \a src parameter is a void pointer. @@ -202,7 +204,9 @@ QT_BEGIN_NAMESPACE Writes the number \a src with template type \c{T} to the memory location at \a dest in big-endian byte order. - Note that template type \c{T} can only be an integer data type (signed or unsigned). + \note Template type \c{T} can either be a quint16, qint16, quint32, qint32, + quint64, or qint64. Other types of integers, e.g., qlong, are not + applicable. There are no data alignment constraints for \a dest. @@ -258,7 +262,9 @@ QT_BEGIN_NAMESPACE Writes the number \a src with template type \c{T} to the memory location at \a dest in little-endian byte order. - Note that template type \c{T} can only be an integer data type (signed or unsigned). + \note Template type \c{T} can either be a quint16, qint16, quint32, qint32, + quint64, or qint64. Other types of integers, e.g., qlong, are not + applicable. There are no data alignment constraints for \a dest. @@ -324,7 +330,7 @@ QT_BEGIN_NAMESPACE \endlist \note Using this class may be slower than using native integers, so only use it when - an exact endian is needed. + an exact endianness is needed. */ /*! \fn template <typename T> QLEInteger<T>::QLEInteger(T value) @@ -443,7 +449,7 @@ QT_BEGIN_NAMESPACE \endlist \note Using this class may be slower than using native integers, so only use it when - an exact endian is needed. + an exact endianness is needed. */ /*! \fn template <typename T> QBEInteger<T>::QBEInteger(T value) |