diff options
| author | Karsten Heimrich <karsten.heimrich@theqtcompany.com> | 2016-02-15 14:13:42 +0100 |
|---|---|---|
| committer | Karsten Heimrich <karsten.heimrich@theqtcompany.com> | 2016-02-15 15:58:31 +0000 |
| commit | 7e68b9549caaaae31a0647998ed7aa3ea2136957 (patch) | |
| tree | e9c04ed589fa3db7c774c3fb91745137c014fec5 /src/serialbus/qmodbuspdu.cpp | |
| parent | 01bc9d50a9ae7d837c9af7e869df215701a44933 (diff) | |
doc: Be more explicit what argument types are supported.
Change-Id: I0e16477923d15bf28df85cdd505a6827c45cabdc
Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
Diffstat (limited to 'src/serialbus/qmodbuspdu.cpp')
| -rw-r--r-- | src/serialbus/qmodbuspdu.cpp | 25 |
1 files changed, 15 insertions, 10 deletions
diff --git a/src/serialbus/qmodbuspdu.cpp b/src/serialbus/qmodbuspdu.cpp index 25a7699..a28130e 100644 --- a/src/serialbus/qmodbuspdu.cpp +++ b/src/serialbus/qmodbuspdu.cpp @@ -233,8 +233,9 @@ static int minimumDataSize(const QModbusPdu &pdu, Type type) Constructs a QModbusPdu with function code set to \a code and payload set to \a data. The data is converted and stored in big-endian byte order. - \note Usage should be limited the POD types only. This is because \c QDataStream stream - operators will not only append raw data, but also e.g. size, count etc. for complex types. + \note Usage is limited \c quint8 and \c quint16 only. This is because + \c QDataStream stream operators will not only append raw data, but also + e.g. size, count etc. for complex types. */ /*! @@ -324,8 +325,9 @@ static int minimumDataSize(const QModbusPdu &pdu, Type type) response.decodeData(&count, &id, &run); \endcode - \note Usage should be limited the POD types only. This is because \c QDataStream stream - operators will not only read raw data, but also e.g. size, count etc. for complex types. + \note Usage is limited \c quint8 and \c quint16 only. This is because + \c QDataStream stream operators will not only append raw data, but also + e.g. size, count etc. for complex types. */ /*! @@ -339,8 +341,9 @@ static int minimumDataSize(const QModbusPdu &pdu, Type type) request.encodeData(quint16(0x0c), quint16(0x0a)); \endcode - \note Usage should be limited the POD types only. This is because \c QDataStream stream - operators will not only append raw data, but also e.g. size, count etc. for complex types. + \note Usage is limited \c quint8 and \c quint16 only. This is because + \c QDataStream stream operators will not only append raw data, but also + e.g. size, count etc. for complex types. */ /*! @@ -419,8 +422,9 @@ QDataStream &operator<<(QDataStream &stream, const QModbusPdu &pdu) Constructs a QModbusRequest with function code set to \a code and payload set to \a data. The data is converted and stored in big-endian byte order. - \note Usage should be limited the POD types only. This is because \c QDataStream stream - operators will not only append raw data, but also e.g. size, count etc. for complex types. + \note Usage is limited \c quint8 and \c quint16 only. This is because + \c QDataStream stream operators will not only append raw data, but also + e.g. size, count etc. for complex types. */ /*! @@ -570,8 +574,9 @@ QDataStream &operator>>(QDataStream &stream, QModbusRequest &pdu) Constructs a QModbusResponse with function code set to \a code and payload set to \a data. The data is converted and stored in big-endian byte order. - \note Usage should be limited the POD types only. This is because \c QDataStream stream - operators will not only append raw data, but also e.g. size, count etc. for complex types. + \note Usage is limited \c quint8 and \c quint16 only. This is because + \c QDataStream stream operators will not only append raw data, but also + e.g. size, count etc. for complex types. */ /*! |