diff options
| author | Laszlo Papp <lpapp@kde.org> | 2013-02-17 20:29:58 +0000 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-02-18 12:17:29 +0100 |
| commit | 867bf0f2a7e814a584153e39b2e482ab284a3dc1 (patch) | |
| tree | cadcbd0b14ddb41220906d9aa406a457519638ce /src/serialport | |
| parent | 96037016c20e3556988350ede7d01a92ab7060e9 (diff) | |
Extend and fix the lines() related public documentation
Change-Id: I016cfa684363045f769b7f01f13ba91237c25158
Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com>
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Diffstat (limited to 'src/serialport')
| -rw-r--r-- | src/serialport/qserialport.cpp | 25 |
1 files changed, 15 insertions, 10 deletions
diff --git a/src/serialport/qserialport.cpp b/src/serialport/qserialport.cpp index 1faba779..b53a56ce 100644 --- a/src/serialport/qserialport.cpp +++ b/src/serialport/qserialport.cpp @@ -320,15 +320,15 @@ int QSerialPortPrivateData::timeoutValue(int msecs, int elapsed) This enum describes the possible RS-232 pinout signals. \value NoLine no any line is active - \value Le DSR (data set ready/line enable). - \value Dtr DTR (data terminal ready). - \value Rts RTS (request to send). - \value St Secondary TXD (transmit). - \value Sr Secondary RXD (receive). - \value Cts CTS (clear to send). - \value Dcd DCD (data carrier detect). - \value Ri RNG (ring). - \value Dsr DSR (data set ready). + \value LeLine DSR (Data Set Ready, Line Enable). + \value DtrLine DTR (Data Terminal Ready). + \value RtsLine RTS (Request To Send). + \value StLine Secondary TXD (Transmit). + \value SrLine Secondary RXD (Receive). + \value CtsLine CTS (Clear To Send). + \value DcdLine DCD (Data Carrier Detect). + \value RiLine RNG (Ring). + \value DsrLine DSR (Data Set Ready). \sa lines(), QSerialPort::dataTerminalReady, QSerialPort::requestToSend */ @@ -879,11 +879,16 @@ bool QSerialPort::isRequestToSend() */ /*! - Returns the bitmap states of the line signals. + Returns the state of the line signals in a bitmap format. + From this result, it is possible to allocate the state of the desired signal by applying a mask "AND", where the mask is the desired enumeration value from QSerialPort::Lines. + Note that, this method performs a system call, thus ensuring that the line + signal states are returned properly. This is necessary when the underlying + operating systems cannot provide proper notifications about the changes. + \sa isDataTerminalReady(), isRequestToSend, setDataTerminalReady(), setRequestToSend() */ |