diff options
| author | Laszlo Papp <lpapp@kde.org> | 2013-01-27 00:51:31 +0000 |
|---|---|---|
| committer | Laszlo Papp <lpapp@kde.org> | 2013-01-27 13:01:22 +0100 |
| commit | d5b47055d0ae2b171bb07f27366d4d9c882f732a (patch) | |
| tree | 0a2958b3ac27233c3bf259a6a51dce588f061560 /examples/doc/terminal.qdoc | |
| parent | 6f5d68fdec2b3b35b995f9ecc2f4844ec4ae9183 (diff) | |
Rename the SerialPort* classes to QSerialPort* including the internals.
Unfortunately, the rename has to happen in a separate commit because of the
limitations of "git":
"git does not track renames of files in history, git only records tree
snapshots. It can try to guess whether a change was a rename, or just unrelated
removal+addition, when asked. You can help this by making the rename in a
different commit from a modification. See man git-log -C and -M"
... so the rename will happen in the next change.
Change-Id: Ibe56eba0a0d2c7489db48a6c519d60d3315c00de
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Diffstat (limited to 'examples/doc/terminal.qdoc')
| -rw-r--r-- | examples/doc/terminal.qdoc | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/examples/doc/terminal.qdoc b/examples/doc/terminal.qdoc index f87be689..090b9577 100644 --- a/examples/doc/terminal.qdoc +++ b/examples/doc/terminal.qdoc @@ -31,28 +31,28 @@ \example examples/terminal The Terminal example shows how to create a terminal for a simple serial - interface by using SerialPort. + interface by using Qt Serial Port. \image terminal-example.png Screenshot of the Terminal example - This example shows the main features of the SerialPort class, like + This example shows the main features of the QSerialPort class, like configuration, I/O implementation and so forth. Also, the class - SerialPortInfo is invoked to display information about the serial ports + QSerialPortInfo is invoked to display information about the serial ports available in the system. - SerialPort supports two general programming approaches: + QSerialPort supports two general programming approaches: \list \o \i{The asynchronous (non-blocking) approach.} Operations are scheduled - and performed when the control returns to Qt's event loop. SerialPort emits - a signal when the operation is finished. For example, SerialPort::write() - returns immediately. When the data is sent to the serial port, SerialPort - emits \l{SerialPort::bytesWritten()}{bytesWritten()}. + and performed when the control returns to Qt's event loop. QSerialPort emits + a signal when the operation is finished. For example, QSerialPort::write() + returns immediately. When the data is sent to the serial port, QSerialPort + emits \l{QSerialPort::bytesWritten()}{bytesWritten()}. \o \i{The synchronous (blocking) approach.} In non-GUI and multithreaded applications, the \c waitFor...() functions can be called (i.e. - SerialPort::waitReadyRead()) to suspend the calling thread until the + QSerialPort::waitReadyRead()) to suspend the calling thread until the operation has completed. \endlist @@ -88,8 +88,8 @@ \dots \snippet examples/terminal/mainwindow.cpp 1 - The only SerialPort signal invoked in this example is - SerialPort::readyRead(), which shows that new data has been received and + The only QSerialPort signal invoked in this example is + QSerialPort::readyRead(), which shows that new data has been received and hence available: \dots |