summaryrefslogtreecommitdiffstats
path: root/src/serialbus/qcanbusframe.cpp
diff options
context:
space:
mode:
authorQt Forward Merge Bot <qt_forward_merge_bot@qt-project.org>2019-07-23 03:01:52 +0200
committerQt Forward Merge Bot <qt_forward_merge_bot@qt-project.org>2019-07-23 03:01:52 +0200
commit3d03ddb2eb80dab71de08c24739a8a683306e802 (patch)
tree5f85749eefcc3f0f3f9d375dcf59946a0c2f578f /src/serialbus/qcanbusframe.cpp
parent6a19c2100180747204e9e77fd0286061ff8a46d7 (diff)
parent4fb3e302a30c675b3d515d6eb5dd08301727d4c1 (diff)
Merge remote-tracking branch 'origin/5.12' into 5.13
Diffstat (limited to 'src/serialbus/qcanbusframe.cpp')
-rw-r--r--src/serialbus/qcanbusframe.cpp12
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()
*/