diff options
author | Laszlo Papp <lpapp@kde.org> | 2013-10-04 00:57:57 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-10-04 09:36:20 +0200 |
commit | 3309138e2574fa277eb3eb65ad26ab0836925f17 (patch) | |
tree | af91f73505c3c04dde26a54fe07f6cf07fd444a8 | |
parent | 7a1f25496b6539f352a8a998014729ee69ef77ad (diff) | |
download | qtserialport-3309138e2574fa277eb3eb65ad26ab0836925f17.tar.gz |
Use the "\note" qdoc command instead of the raw "Note" term
Change-Id: If9631df1be0a164140c95b52e8537fc849709ee9
Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com>
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
-rw-r--r-- | src/serialport/qserialport.cpp | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/src/serialport/qserialport.cpp b/src/serialport/qserialport.cpp index 531dc39..fb427dc 100644 --- a/src/serialport/qserialport.cpp +++ b/src/serialport/qserialport.cpp @@ -184,8 +184,9 @@ int QSerialPortPrivateData::timeoutValue(int msecs, int elapsed) \enum QSerialPort::BaudRate This enum describes the baud rate which the communication device operates - with. Note: only the most common standard baud rates are listed in this - enum. + with. + + \note Only the most common standard baud rates are listed in this enum. \value Baud1200 1200 baud. \value Baud2400 2400 baud. @@ -821,8 +822,8 @@ bool QSerialPort::isRequestToSend() desired signal by applying a mask "AND", where the mask is the desired enumeration value from QSerialPort::PinoutSignals. - Note that, this method performs a system call, thus ensuring that the line - signal states are returned properly. This is necessary when the underlying + \note 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(), |