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/creadersync.qdoc | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'examples/serialport/doc/creadersync.qdoc') diff --git a/examples/serialport/doc/creadersync.qdoc b/examples/serialport/doc/creadersync.qdoc index 3b6c968f..6c3f4a89 100644 --- a/examples/serialport/doc/creadersync.qdoc +++ b/examples/serialport/doc/creadersync.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 creadersync \title Command Line Reader Sync Example \ingroup qtserialport-examples + \brief Shows how to receive data synchronously over serial port. - 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. + \e{Command Line Reader Sync} 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 + \image creadersync-example.png This command line reader sync example receives data synchronously 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()}, and \l{QIODevice::waitForReadyRead()}{waitForReadyRead()} methods. + + \include examples-run.qdocinc */ -- cgit v1.2.3