diff options
author | Andre Hartmann <aha_1980@gmx.de> | 2017-09-28 18:20:23 +0200 |
---|---|---|
committer | André Hartmann <aha_1980@gmx.de> | 2017-09-29 07:24:50 +0000 |
commit | 90081a1b3698375067a2177048df42a88f089dd9 (patch) | |
tree | 7d5fd268002712e7a841d97e9f61615dfa1aeadc /src | |
parent | 2a8284543018943ab581202cf934c751a22db6c7 (diff) | |
download | qtserialport-90081a1b3698375067a2177048df42a88f089dd9.tar.gz |
Update waitFor{ReadyRead|BytesWritten} documentation for timeouts
[ChangeLog][QSerialPort] Added a note to the documentation that
waitForReadyRead() and waitForBytesWritten() never time out if
the parameter msecs is -1.
Change-Id: I5852da14faf1bba5a338db6a8764da582238aae7
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/serialport/qserialport.cpp | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/serialport/qserialport.cpp b/src/serialport/qserialport.cpp index 5534bb8..8ea5a48 100644 --- a/src/serialport/qserialport.cpp +++ b/src/serialport/qserialport.cpp @@ -1309,7 +1309,7 @@ bool QSerialPort::canReadLine() const This function blocks until new data is available for reading and the \l{QIODevice::}{readyRead()} signal has been emitted. The function will timeout after \a msecs milliseconds; the default timeout is - 30000 milliseconds. + 30000 milliseconds. If \a msecs is -1, this function will not time out. The function returns \c true if the readyRead() signal is emitted and there is new data available for reading; otherwise it returns \c false @@ -1341,7 +1341,7 @@ bool QSerialPort::waitForReadyRead(int msecs) This function blocks until at least one byte has been written to the serial port and the \l{QIODevice::}{bytesWritten()} signal has been emitted. The function will timeout after \a msecs milliseconds; the default timeout is - 30000 milliseconds. + 30000 milliseconds. If \a msecs is -1, this function will not time out. The function returns \c true if the bytesWritten() signal is emitted; otherwise it returns \c false (if an error occurred or the operation timed out). |