summaryrefslogtreecommitdiffstats
path: root/examples/serialport/doc
diff options
context:
space:
mode:
authorLaszlo Papp <lpapp@kde.org>2013-10-26 10:53:16 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-11-05 08:16:03 +0100
commit26458aef426cde967433035d2af0ab244db3aec0 (patch)
tree0fe0493775b295a0917f539ddd333e3dc0684079 /examples/serialport/doc
parentca6365369d6676053878d7501f8236582eed94b7 (diff)
Add a new simple and command line async writer example
Change-Id: I8f33126de5c78da9a4a0dbddd16eecde7044f0c5 Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Diffstat (limited to 'examples/serialport/doc')
-rw-r--r--examples/serialport/doc/cwriterasync.qdoc46
1 files changed, 46 insertions, 0 deletions
diff --git a/examples/serialport/doc/cwriterasync.qdoc b/examples/serialport/doc/cwriterasync.qdoc
new file mode 100644
index 00000000..884435bc
--- /dev/null
+++ b/examples/serialport/doc/cwriterasync.qdoc
@@ -0,0 +1,46 @@
+/****************************************************************************
+**
+** 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 cwriterasync
+ \title Command Line Writer Async Example
+ \ingroup qtserialport-examples
+
+ The Command Line Writer Async example shows how to use the QSerialPort class
+ for sending data asynchronously over the selected serial port with the
+ desired settings.
+
+ \image cwriterasync-example.png Screenshot of the Command Line Writer Async
+ example
+
+ This command line writer async example sends data asynchronously over the
+ selected serial port in a console, provided by the QSerialPort class.
+
+ For sending data asynchronously over the selected serial port, use the
+ \l{QIODevice::write()}{write()} method and
+ \l{QIODevice::bytesWritten()}{bytesWritten()} signal.
+*/