diff options
| author | Andre Hartmann <aha_1980@gmx.de> | 2018-03-29 19:37:40 +0200 |
|---|---|---|
| committer | André Hartmann <aha_1980@gmx.de> | 2018-04-03 08:47:20 +0000 |
| commit | fb561e9aa52d24b0156dc2c3987216954ad52107 (patch) | |
| tree | 15fa8db06f3785732e056762dd4a81abc5c27c1a | |
| parent | c6661d888530ebaf0d893d7692d451c84f2b5645 (diff) | |
Improve QCanBusDeviceInfo documentationv5.11.0-beta4v5.11.0-beta3
* Add a link to QCanBusDeviceInfo on the "Qt CAN Bus" page
* Add an example for channel()
Change-Id: I95e7a36b998c2bb27abdd6839c9653a7c14568e9
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
| -rw-r--r-- | src/serialbus/doc/src/qtcanbus-backends.qdoc | 1 | ||||
| -rw-r--r-- | src/serialbus/qcanbusdeviceinfo.cpp | 3 |
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 |