From ccdf42d9d10a32ccdd4a12c643130ffdea498552 Mon Sep 17 00:00:00 2001 From: Laszlo Papp Date: Thu, 24 Oct 2013 19:21:22 +0100 Subject: Add a new simple and command line reader example Change-Id: I69c05be5db564888986925d943aff32221f5b310 Reviewed-by: Sergey Belyashov Reviewed-by: Denis Shienkov --- examples/serialport/doc/creadersync.qdoc | 45 ++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 examples/serialport/doc/creadersync.qdoc (limited to 'examples/serialport/doc') diff --git a/examples/serialport/doc/creadersync.qdoc b/examples/serialport/doc/creadersync.qdoc new file mode 100644 index 00000000..bc790cfc --- /dev/null +++ b/examples/serialport/doc/creadersync.qdoc @@ -0,0 +1,45 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Laszlo Papp +** 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 Sync Example + \ingroup qtserialport-examples + + 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. + + \image creadersync-example.png Screenshot of the Command Line Reader Sync example + + This command line reader sync example receives data synchronously 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()}, + and \l{QIODevice::waitForReadyRead()}{waitForReadyRead()} methods. +*/ -- cgit v1.2.3