QUuid: improve documentation regarding the order parameter

Clarify that the order is the expected byte order of the input data.

Found during Qt 6.6 API Review.

Change-Id: Iaa1f5eef22df60676e52197fbcf613f6e9970a3e
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Reviewed-by: Marc Mutz <marc.mutz@qt.io>
(cherry picked from commit 17297e17927631f22dbb342c00f65af6a2b5a5e1)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Ivan Solovev 2023-08-15 17:57:33 +02:00 committed by Qt Cherry-pick Bot
parent 9f0a95a806
commit bc88069890

View File

@ -304,8 +304,8 @@ static QUuid createFromName(const QUuid &ns, const QByteArray &baseData, QCrypto
\fn QUuid::QUuid(Id128Bytes id128, QSysInfo::Endian order) noexcept
\since 6.6
Creates a QUuid based on the integral \a id128 parameter and respecting the
byte order \a order.
Creates a QUuid based on the integral \a id128 parameter. The input
\a id128 parameter is considered to have byte order \a order.
\sa fromBytes(), toBytes(), toRfc4122(), toUInt128()
*/
@ -314,8 +314,8 @@ static QUuid createFromName(const QUuid &ns, const QByteArray &baseData, QCrypto
\fn QUuid::fromUInt128(quint128 uuid, QSysInfo::Endian order) noexcept
\since 6.6
Creates a QUuid based on the integral \a uuid parameter and respecting the
byte order \a order.
Creates a QUuid based on the integral \a uuid parameter. The input \a uuid
parameter is considered to have byte order \a order.
\note This function is only present on platforms that offer a 128-bit
integer type.