From 7328fe502a08ff26d70ee5d137e554a77a118f9b Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Thu, 10 Jul 2014 15:15:23 +0200 Subject: Doc: Edited example documentation. -added information about how to run the example by including a file from qtbase/doc/global -edited summary sections -added \brief. -removed image captions. Our Qt 5 CSS files don't handle them. Task-number: QTBUG-33597 Change-Id: If3293aa9d98b662f20af2af7030b0ab0fb1e8401 Reviewed-by: Denis Shienkov Reviewed-by: Leena Miettinen --- examples/serialport/doc/creaderasync.qdoc | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'examples/serialport/doc/creaderasync.qdoc') diff --git a/examples/serialport/doc/creaderasync.qdoc b/examples/serialport/doc/creaderasync.qdoc index a8b2101..ff5e9c6 100644 --- a/examples/serialport/doc/creaderasync.qdoc +++ b/examples/serialport/doc/creaderasync.qdoc @@ -1,6 +1,7 @@ /**************************************************************************** ** ** Copyright (C) 2013 Laszlo Papp +** 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 creaderasync \title Command Line Reader Async Example \ingroup qtserialport-examples + \brief Shows how to receive data asynchronously over serial port. - The Command Line Reader Async example shows how to use the QSerialPort class for + \e{Command Line Reader Async} 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 + \image creaderasync-example.png This command line reader async example receives data asynchronously 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()} methods, and \l{QIODevice::readyRead()}{readyRead()} signal. + + \include examples-run.qdocinc */ -- cgit v1.2.1