summaryrefslogtreecommitdiffstats
path: root/src/serialbus/qcanbusdevice.cpp
diff options
context:
space:
mode:
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()
{