summaryrefslogtreecommitdiffstats
path: root/src/serialbus/qcanbusdevice.cpp
diff options
context:
space:
mode:
authorLiang Qi <liang.qi@qt.io>2017-10-30 08:45:42 +0100
committerLiang Qi <liang.qi@qt.io>2017-10-30 09:27:47 +0100
commit3e71f12de6995b2d9aa77b78f86251e49de8b2c5 (patch)
treeb3a481ba80560cb671dd570db8931200838033be /src/serialbus/qcanbusdevice.cpp
parenta24e76d16ab3c3b18180e3dce554bc7696ea91c0 (diff)
parent60c0114e846a593895503a78d13b006f93e95675 (diff)
Merge remote-tracking branch 'origin/5.9' into 5.10v5.10.0-beta4
Conflicts: .qmake.conf Change-Id: Icfbad81955ad8a7c4ddc49ac4ee952bcba6317ec
Diffstat (limited to 'src/serialbus/qcanbusdevice.cpp')
-rw-r--r--src/serialbus/qcanbusdevice.cpp7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/serialbus/qcanbusdevice.cpp b/src/serialbus/qcanbusdevice.cpp
index f613f0a..919c38a 100644
--- a/src/serialbus/qcanbusdevice.cpp
+++ b/src/serialbus/qcanbusdevice.cpp
@@ -631,6 +631,8 @@ QCanBusFrame QCanBusDevice::readFrame()
otherwise \c false.
This function calls \l open() as part of its implementation.
+
+ \sa disconnectDevice()
*/
bool QCanBusDevice::connectDevice()
{
@@ -658,6 +660,11 @@ bool QCanBusDevice::connectDevice()
Disconnects the device from the CAN bus.
This function calls \l close() as part of its implementation.
+
+ \note This function should only be called, if connectDevice()
+ returned \c true.
+
+ \sa connectDevice()
*/
void QCanBusDevice::disconnectDevice()
{