diff options
| author | Paul Wicking <paul.wicking@qt.io> | 2019-07-18 13:11:43 +0200 |
|---|---|---|
| committer | Paul Wicking <paul.wicking@qt.io> | 2019-07-22 06:09:02 +0200 |
| commit | 4fb3e302a30c675b3d515d6eb5dd08301727d4c1 (patch) | |
| tree | 6ad7dba51b6610555191186526240681075b6786 | |
| parent | dd9b3d7ee62019d75764be7e49468976708f16fd (diff) | |
Doc: Add precision to QCanBusFrame::setFrameId description
Done-with: Jochen Bauer
Fixes: QTBUG-75502
Change-Id: I3a91c9b0c52985f5fe3ea357c8813c27ddbfd28d
Reviewed-by: André Hartmann <aha_1980@gmx.de>
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
| -rw-r--r-- | src/serialbus/qcanbusframe.cpp | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/src/serialbus/qcanbusframe.cpp b/src/serialbus/qcanbusframe.cpp index 8ba0cc7..c62539e 100644 --- a/src/serialbus/qcanbusframe.cpp +++ b/src/serialbus/qcanbusframe.cpp @@ -80,9 +80,15 @@ QT_BEGIN_NAMESPACE /*! \fn QCanBusFrame::setFrameId(quint32 newFrameId) - Sets the identifier of the CAN frame to \a newFrameId. The maximum size of a CAN frame - identifier is 11 bits, which can be extended up to 29 bits by supporting the \e {CAN extended frame - format}. The \e {CAN extended frame format} setting is automatically adapted to match \a newFrameId. + Sets the identifier of the CAN frame to \a newFrameId. + + The maximum size of a CAN frame identifier is 11 bits, which can be + extended up to 29 bits by supporting the \e {CAN extended frame format}. + The \e {CAN extended frame format} setting is automatically set when a + \a newFrameId with more than 11 bits in size is given. + + When the format is extended and a \a newFrameId with up to 11 bits or less + is passed, the \e {CAN extended frame format} setting is \a not changed. \sa frameId(), hasExtendedFrameFormat() */ |