From 10ea89238b353e4d9a787bc04cfecaf6568dd493 Mon Sep 17 00:00:00 2001 From: Laszlo Papp Date: Thu, 28 Nov 2013 08:35:53 +0000 Subject: Document the real meaning of the parity enumeration values Change-Id: I58f689e6bf8480c5a608f91d7f4fb7a83235d631 Reviewed-by: Denis Shienkov Reviewed-by: Sergey Belyashov --- src/serialport/qserialport.cpp | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) (limited to 'src/serialport/qserialport.cpp') diff --git a/src/serialport/qserialport.cpp b/src/serialport/qserialport.cpp index 7c332cc..9c7dbbd 100644 --- a/src/serialport/qserialport.cpp +++ b/src/serialport/qserialport.cpp @@ -222,11 +222,20 @@ int QSerialPortPrivateData::timeoutValue(int msecs, int elapsed) This enum describes the parity scheme used. - \value NoParity No parity. - \value EvenParity Even parity. - \value OddParity Odd parity. - \value SpaceParity Space parity. - \value MarkParity Mark parity. + \value NoParity No parity bit it sent. This is the most common + parity setting. Error detection is handled by the + communication protocol. + \value EvenParity The number of 1 bits in each character, including + the parity bit, is always even. + \value OddParity The number of 1 bits in each character, including + the parity bit, is always odd. It ensures that at + least one state transition occurs in each character. + \value SpaceParity Space parity. The parity bit is sent in the space + signal condition. It does not provide error + detection information. + \value MarkParity Mark parity. The parity bit is always set to the + mark signal condition (logical 1). It does not + provide error detection information. \value UnknownParity Unknown parity. \sa QSerialPort::parity -- cgit v1.2.1