diff options
| author | Jerome Pasion <jerome.pasion@digia.com> | 2014-07-10 15:15:23 +0200 |
|---|---|---|
| committer | Jerome Pasion <jerome.pasion@digia.com> | 2014-07-14 10:51:02 +0200 |
| commit | 7328fe502a08ff26d70ee5d137e554a77a118f9b (patch) | |
| tree | 0f2b69678a5b9f6b8384fc99d4b6d876c0742b87 /examples/serialport/doc/cwritersync.qdoc | |
| parent | 55b29ef40df2b1f91ecab06c492ca70ba5e0297f (diff) | |
| download | qtserialport-7328fe502a08ff26d70ee5d137e554a77a118f9b.tar.gz | |
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 <denis.shienkov@gmail.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Diffstat (limited to 'examples/serialport/doc/cwritersync.qdoc')
| -rw-r--r-- | examples/serialport/doc/cwritersync.qdoc | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/examples/serialport/doc/cwritersync.qdoc b/examples/serialport/doc/cwritersync.qdoc index 05858ef..03086e0 100644 --- a/examples/serialport/doc/cwritersync.qdoc +++ b/examples/serialport/doc/cwritersync.qdoc @@ -1,6 +1,7 @@ /**************************************************************************** ** ** Copyright (C) 2013 Laszlo Papp <lpapp@kde.org> +** 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 cwritersync \title Command Line Writer Sync Example \ingroup qtserialport-examples + \brief Shows how to send data synchronously over serial port. - 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. + \e{Command Line Writer Sync} 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 + \image cwritersync-example.png This command line writer sync example sends data synchronously over the selected serial port in a console, provided by the QSerialPort class. @@ -42,4 +44,6 @@ For sending data synchronously over the selected serial port, use the \l{QIODevice::write()}{write()} and \l{QIODevice::waitForBytesWritten()}{waitForBytesWritten()} methods. + + \include examples-run.qdocinc */ |