diff options
| author | Andre Hartmann <aha_1980@gmx.de> | 2016-12-20 10:01:14 +0100 |
|---|---|---|
| committer | André Hartmann <aha_1980@gmx.de> | 2016-12-20 14:28:38 +0000 |
| commit | f3cb65adffa43b337df8f8298091db46c1fbfa24 (patch) | |
| tree | 50e9b84fe2cc47257c462f2c359f3bc8b7495d5a | |
| parent | b1cc80d3031c60a12a006657992d2311f6ac9db4 (diff) | |
QCanBusDevice::framesToWrite: Extend documentation
[ChangeLog][QCanBusDevice] Add buffering details
in QCanBusDevice::framesToWrite documentation.
Task-number: QTBUG-57658
Change-Id: Iaa0d6616dbee3c192bcdc1ee45117cfd46c02188
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
| -rw-r--r-- | src/serialbus/qcanbusdevice.cpp | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/src/serialbus/qcanbusdevice.cpp b/src/serialbus/qcanbusdevice.cpp index c80753a..b9ae839 100644 --- a/src/serialbus/qcanbusdevice.cpp +++ b/src/serialbus/qcanbusdevice.cpp @@ -399,7 +399,12 @@ qint64 QCanBusDevice::framesAvailable() const } /*! - Returns the number of frames waiting to be written. + For buffered devices, this function returns the number of frames waiting to be written. + For unbuffered devices, this function always returns zero. + + \note There may be additional buffering in the CAN driver and CAN hardware layer. + Therefore, if this function returns zero, that does not mean all CAN frames are + already written to the CAN bus. \sa writeFrame() */ |