summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--src/serialbus/doc/src/qtcanbus-backends.qdoc1
-rw-r--r--src/serialbus/qcanbusdeviceinfo.cpp3
2 files changed, 3 insertions, 1 deletions
diff --git a/src/serialbus/doc/src/qtcanbus-backends.qdoc b/src/serialbus/doc/src/qtcanbus-backends.qdoc
index 1c4cd74..7942ace 100644
--- a/src/serialbus/doc/src/qtcanbus-backends.qdoc
+++ b/src/serialbus/doc/src/qtcanbus-backends.qdoc
@@ -42,6 +42,7 @@
\list
\li QCanBus provides an API to create a QCanBusDevice from a chosen plugin.
+ \li QCanBusDeviceInfo provides information about available CAN devices.
\li QCanBusDevice provides an API for direct access to the CAN device.
\li QCanBusFrame defines a CAN frame that can be written and read from QCanBusDevice.
\endlist
diff --git a/src/serialbus/qcanbusdeviceinfo.cpp b/src/serialbus/qcanbusdeviceinfo.cpp
index 25c02e1..78dcd89 100644
--- a/src/serialbus/qcanbusdeviceinfo.cpp
+++ b/src/serialbus/qcanbusdeviceinfo.cpp
@@ -119,7 +119,8 @@ QString QCanBusDeviceInfo::serialNumber() const
/*!
\since 5.11
Returns the sequential channel number of the CAN bus interface, starting
- with zero. If the interface has only one channel or if no information about
+ with zero. For example, a two channel CAN interface may have the channels
+ 0 and 1. If the interface has only one channel or if no information about
the channel is available, zero is returned.
*/
int QCanBusDeviceInfo::channel() const