summaryrefslogtreecommitdiffstats
path: root/examples/serialport/doc/creadersync.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/serialport/doc/creadersync.qdoc')
-rw-r--r--examples/serialport/doc/creadersync.qdoc12
1 files changed, 8 insertions, 4 deletions
diff --git a/examples/serialport/doc/creadersync.qdoc b/examples/serialport/doc/creadersync.qdoc
index 3b6c968f..6c3f4a89 100644
--- a/examples/serialport/doc/creadersync.qdoc
+++ b/examples/serialport/doc/creadersync.qdoc
@@ -1,6 +1,7 @@
/****************************************************************************
**
** Copyright (C) 2013 Laszlo Papp <lpapp@kde.org>
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
@@ -29,12 +30,13 @@
\example creadersync
\title Command Line Reader Sync Example
\ingroup qtserialport-examples
+ \brief Shows how to receive data synchronously over serial port.
- The Command Line Reader Sync example shows how to use the QSerialPort class for
- receiving data synchronously over the selected serial port with the desired
- settings.
+ \e{Command Line Reader Sync} shows how to use the QSerialPort class
+ for receiving data synchronously over the selected serial port with the
+ desired settings.
- \image creadersync-example.png Screenshot of the Command Line Reader Sync example
+ \image creadersync-example.png
This command line reader sync example receives data synchronously over the
selected serial port in a console, provided by the QSerialPort class.
@@ -42,4 +44,6 @@
For receiving data synchronously over the selected serial port, use the
\l{QSerialPort::read()}{read()} or \l{QSerialPort::readAll()}{readAll()},
and \l{QIODevice::waitForReadyRead()}{waitForReadyRead()} methods.
+
+ \include examples-run.qdocinc
*/