summaryrefslogtreecommitdiffstats
path: root/examples/serialport/doc
diff options
context:
space:
mode:
authorLaszlo Papp <lpapp@kde.org>2013-10-24 13:53:16 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-25 12:30:09 +0200
commit9f8f2d6dc6f38b54a91f4a3d7ebf4285891005d3 (patch)
treef0d8b3e566fa71c31fe12ccb6ee67a99119dbb95 /examples/serialport/doc
parentc872f638199575e63d1b18b204da67ce64c9a020 (diff)
Add a new simple and command line writer example
Change-Id: I5d893d18477790def27bfa1fa051d459a8193db5 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/cwritersync.qdoc45
1 files changed, 45 insertions, 0 deletions
diff --git a/examples/serialport/doc/cwritersync.qdoc b/examples/serialport/doc/cwritersync.qdoc
new file mode 100644
index 00000000..05858ef7
--- /dev/null
+++ b/examples/serialport/doc/cwritersync.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 cwritersync
+ \title Command Line Writer Sync Example
+ \ingroup qtserialport-examples
+
+ The Command Line Writer Sync example shows how to use the QSerialPort class
+ for sending data synchronously over the selected serial port with the
+ desired settings.
+
+ \image cwritersync-example.png Screenshot of the Command Line Writer Sync example
+
+ This command line writer sync example sends data synchronously over the
+ selected serial port in a console, provided by the QSerialPort class.
+
+ For sending data synchronously over the selected serial port, use the
+ \l{QIODevice::write()}{write()} and
+ \l{QIODevice::waitForBytesWritten()}{waitForBytesWritten()} methods.
+*/