diff options
| author | Andre Hartmann <aha_1980@gmx.de> | 2017-05-19 19:15:44 +0200 |
|---|---|---|
| committer | André Hartmann <aha_1980@gmx.de> | 2017-05-23 10:35:09 +0000 |
| commit | b3bd36122f0640372ee8427c0e0370b60e7da6af (patch) | |
| tree | d2e881b16ded26a76f735beddcc88c5b81848862 | |
| parent | 0fd8787ff91116b36d46f46364b02411d5b239a6 (diff) | |
CAN: Add requirements to plugin documentation
Change-Id: I0dbbf10d8448c5d26f28bd7fa84cdeab21e6eb5c
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
| -rw-r--r-- | src/serialbus/doc/src/peakcan.qdoc | 3 | ||||
| -rw-r--r-- | src/serialbus/doc/src/socketcan.qdoc | 3 | ||||
| -rw-r--r-- | src/serialbus/doc/src/systeccan.qdoc | 3 | ||||
| -rw-r--r-- | src/serialbus/doc/src/vectorcan.qdoc | 3 |
4 files changed, 12 insertions, 0 deletions
diff --git a/src/serialbus/doc/src/peakcan.qdoc b/src/serialbus/doc/src/peakcan.qdoc index d47d776..b0c59c3 100644 --- a/src/serialbus/doc/src/peakcan.qdoc +++ b/src/serialbus/doc/src/peakcan.qdoc @@ -33,6 +33,9 @@ The PeakCAN plugin encapsulates the low-level API to work with the \l{http://www.peak-system.com/}{PEAK-System} CAN adapters. + This plugin requires the PCAN device drivers and the pcanbasic library + (pcanbasic.dll under Windows). + \section1 Creating CAN Bus Devices At first it is necessary to check that QCanBus provides the desired plugin: diff --git a/src/serialbus/doc/src/socketcan.qdoc b/src/serialbus/doc/src/socketcan.qdoc index 74a8dab..12f96fd 100644 --- a/src/serialbus/doc/src/socketcan.qdoc +++ b/src/serialbus/doc/src/socketcan.qdoc @@ -34,6 +34,9 @@ This API is a set of open source CAN drivers and a networking stack contributed by Volkswagen Research to the Linux kernel. + This plugin requires a Linux Kernel with SocketCAN support and SocketCAN device + drivers for the used CAN hardware. + \section1 SocketCAN usage To list all (including unconfigured) network interfaces, the command diff --git a/src/serialbus/doc/src/systeccan.qdoc b/src/serialbus/doc/src/systeccan.qdoc index 08ecfce..dda9dd5 100644 --- a/src/serialbus/doc/src/systeccan.qdoc +++ b/src/serialbus/doc/src/systeccan.qdoc @@ -33,6 +33,9 @@ The SystecCAN backend encapsulates the low-level API to work with the \l{http://www.systec-electronic.com/}{SYS TEC} CAN adapters. + This plugin requires the SYS TEC CAN device drivers and the usbcan32.dll + (usbcan64.dll for 64 bit builds). + \section1 Creating CAN Bus Devices At first it is necessary to check that QCanBus provides the desired backend: diff --git a/src/serialbus/doc/src/vectorcan.qdoc b/src/serialbus/doc/src/vectorcan.qdoc index f95f956..5b95a83 100644 --- a/src/serialbus/doc/src/vectorcan.qdoc +++ b/src/serialbus/doc/src/vectorcan.qdoc @@ -33,6 +33,9 @@ The VectorCAN plugin encapsulates the low-level API to work with the \l{http://www.vector.com/}{Vector Informatik} CAN adapters. + This plugin requires the Vector CAN device drivers and the vxlapi.dll + (vxlapi64.dll for 64 bit builds). + \section1 Creating CAN Bus Devices At first it is necessary to check that QCanBus provides the desired plugin: |