diff options
| author | Andre Hartmann <aha_1980@gmx.de> | 2017-10-30 08:08:16 +0100 |
|---|---|---|
| committer | Liang Qi <liang.qi@qt.io> | 2017-11-03 11:37:25 +0000 |
| commit | be9168aebae32a86094e6dfcb32b454b4887ff33 (patch) | |
| tree | 8321dd68dc51cd828ef8f41a5a6a2754fda3d184 | |
| parent | 60c0114e846a593895503a78d13b006f93e95675 (diff) | |
QCanBus: Extend documentation for CAN device usage
Change-Id: I16406e1d5c344daeb16856bacf1db857f1b820f7
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
| -rw-r--r-- | src/serialbus/qcanbus.cpp | 19 |
1 files changed, 17 insertions, 2 deletions
diff --git a/src/serialbus/qcanbus.cpp b/src/serialbus/qcanbus.cpp index 6b74bd7..5c1ddc8 100644 --- a/src/serialbus/qcanbus.cpp +++ b/src/serialbus/qcanbus.cpp @@ -147,6 +147,17 @@ static QObject *canBusFactory(const QString &plugin, QString *errorMessage) \note Some plugins might not or only partially support this function. + For example, the following call returns a list of all available SocketCAN + interfaces (which can be used for \l createDevice()): + + \code + QString errorString; + const QList<QCanBusDeviceInfo> devices = QCanBus::instance()->availableDevices( + QStringLiteral("socketcan"), &errorString); + if (!errorString.isEmpty()) + qDebug() << errorString; + \endcode + \sa createDevice() */ QList<QCanBusDeviceInfo> QCanBus::availableDevices(const QString &plugin, QString *errorMessage) const @@ -180,9 +191,13 @@ QList<QCanBusDeviceInfo> QCanBus::availableDevices(const QString &plugin, QStrin For example, the following call would connect to the SocketCAN interface vcan0: \code + QString errorString; QCanBusDevice *device = QCanBus::instance()->createDevice( - QStringLiteral("socketcan"), QStringLiteral("vcan0")); - device->connectDevice(); + QStringLiteral("socketcan"), QStringLiteral("vcan0"), &errorString); + if (!device) + qDebug() << errorString; + else + device->connectDevice(); \endcode \note The \a interfaceName is plugin-dependent. See the corresponding plugin documentation |