diff options
2 files changed, 8 insertions, 0 deletions
diff --git a/src/serialport/doc/src/index.qdoc b/src/serialport/doc/src/index.qdoc
index 041188e0..d5823d23 100644
--- a/src/serialport/doc/src/index.qdoc
+++ b/src/serialport/doc/src/index.qdoc
@@ -41,6 +41,8 @@
\li Text mode.
\li Configuring timeouts and delays while reading or writing.
\li Pinout signal change notification.
+ \li Special transceiver conditions, like Framing error, Parity error and
+ Break condition error.
To use the serial port in your application, add the following include
diff --git a/src/serialport/qserialport.cpp b/src/serialport/qserialport.cpp
index 44d6cd14..69f42b2b 100644
--- a/src/serialport/qserialport.cpp
+++ b/src/serialport/qserialport.cpp
@@ -188,6 +188,12 @@ void QSerialPortPrivate::setError(const QSerialPortErrorInfo &errorInfo)
errorOccurred() signal. You can also call error() to find the type of
error that occurred last.
+ \note Not all error conditions are handled in a platform independent way in
+ QSerialport, as for example the Framing, Parity, and Break condition errors.
+ These kind of errors need to be handled by the application code, probably
+ using OS system specific ioctls on the device descriptor and/or parsing the
+ stream's byte-stuffing.
Programming with a blocking serial port is radically different from
programming with a non-blocking serial port. A blocking serial port
does not require an event loop and typically leads to simpler code.