Add a new simple and command line async reader example

Change-Id: I4142d187c3ad37d1e7f5219df3d50679a9f35a8e
Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com>
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>

1 files changed, 45 insertions, 0 deletions

diff --git a/examples/serialport/doc/creaderasync.qdoc b/examples/serialport/doc/creaderasync.qdoc
new file mode 100644
index 00000000..23498565
--- /dev/null
+++ b/examples/serialport/doc/creaderasync.qdoc
@@ -0,0 +1,45 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Laszlo Papp <lpapp@kde.org>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \example creader
+    \title Command Line Reader Async Example
+    \ingroup qtserialport-examples
+
+    The Command Line Reader Async example shows how to use the QSerialPort class for
+    receiving data asynchronously over the selected serial port with the desired
+    settings.
+
+    \image creaderasync-example.png Screenshot of the Command Line Reader Async example
+
+    This command line reader async example receives data asynchronously over the
+    selected serial port in a console, provided by the QSerialPort class.
+
+    For receiving data synchronously over the selected serial port, use the
+    \l{QSerialPort::read()}{read()} or \l{QSerialPort::readAll()}{readAll()}
+    methods, and \l{QIODevice::readyRead()}{readyRead()} signal.
+*/