summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaszlo Papp <lpapp@kde.org>2013-11-30 12:34:35 +0000
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-12-01 07:33:53 +0100
commit8bb0677e83dc7aa49eb46bf24837be7ef82427a1 (patch)
tree6dcbfa9097ae96a341c4658f2d1bb9beb1760eb1
parentc070632fc73be89889f8297263d86b32390acd4c (diff)
downloadqtserialport-8bb0677e83dc7aa49eb46bf24837be7ef82427a1.tar.gz
Document the real meaning of the data bits enumeration values
Change-Id: I7e12e26e6676ecb064eb06599234d2844041335d Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com> Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com>
-rw-r--r--src/serialport/qserialport.cpp16
1 files changed, 12 insertions, 4 deletions
diff --git a/src/serialport/qserialport.cpp b/src/serialport/qserialport.cpp
index 0a6f276..97ed0cd 100644
--- a/src/serialport/qserialport.cpp
+++ b/src/serialport/qserialport.cpp
@@ -208,10 +208,18 @@ int QSerialPortPrivateData::timeoutValue(int msecs, int elapsed)
This enum describes the number of data bits used.
- \value Data5 Five bits.
- \value Data6 Six bits.
- \value Data7 Seven bits
- \value Data8 Eight bits.
+ \value Data5 The number of data bits in each character is 5. It
+ is used for Baudot code. It generally only makes
+ sense with older equipments such as teleprinters.
+ \value Data6 The number of data bits in each character is 6. It
+ is rarely used.
+ \value Data7 The number of data bits in each character is 7. It
+ is used for true ASCII. It generally only makes
+ sense with older equipments such as teleprinters.
+ \value Data8 The number of data bits in each character is 8. It
+ is used for most kinds of data, as this size matches
+ the size of a byte. It is almost universally used in
+ newer applications.
\value UnknownDataBits Unknown number of bits.
\sa QSerialPort::dataBits