qfloat16: use new \compares command

... to describe the comparison operators provided by this class.

Task-number: QTBUG-119433
Change-Id: Ifde49fb60aa50b733a35aa01c7a031b82fb06836
Reviewed-by: Marc Mutz <marc.mutz@qt.io>
(cherry picked from commit 4281495f52c22326ae961849d8ad7362c30168d2)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Ivan Solovev 2023-12-19 16:30:17 +01:00 committed by Qt Cherry-pick Bot
parent 7eeb96c290
commit bc60c5183d

View File

@ -23,6 +23,15 @@ QT_IMPL_METATYPE_EXTERN(qfloat16)
\inheaderfile QFloat16
\brief Provides 16-bit floating point support.
\compares partial
\compareswith partial float double {long double} qint8 quint8 qint16 quint16 \
qint32 quint32 long {unsigned long} qint64 quint64
\endcompareswith
\compareswith partial qint128 quint128
Comparison with 128-bit integral types is only supported if Qt provides
these types.
\endcompareswith
The \c qfloat16 class provides support for half-precision (16-bit) floating
point data. It is fully compliant with IEEE 754 as a storage type. This
implies that any arithmetic operation on a \c qfloat16 instance results in