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/blockingmaster.qdoc | 12 +++++++----- examples/serialport/doc/blockingslave.qdoc | 10 +++++++--- examples/serialport/doc/cenumerator.qdoc | 14 ++++++++------ examples/serialport/doc/creaderasync.qdoc | 8 ++++++-- examples/serialport/doc/creadersync.qdoc | 12 ++++++++---- examples/serialport/doc/cwriterasync.qdoc | 13 ++++++++----- examples/serialport/doc/cwritersync.qdoc | 12 ++++++++---- examples/serialport/doc/enumerator.qdoc | 8 ++++++-- examples/serialport/doc/terminal.qdoc | 10 +++++++--- examples/serialport/examples.qdoc | 25 +++++++++++-------------- 10 files changed, 76 insertions(+), 48 deletions(-) (limited to 'examples/serialport') diff --git a/examples/serialport/doc/blockingmaster.qdoc b/examples/serialport/doc/blockingmaster.qdoc index 32176a13..0aa0c3f2 100644 --- a/examples/serialport/doc/blockingmaster.qdoc +++ b/examples/serialport/doc/blockingmaster.qdoc @@ -2,6 +2,7 @@ ** ** Copyright (C) 2011 - 2012 Denis Shienkov ** Copyright (C) 2012 - 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. @@ -30,13 +31,12 @@ \example blockingmaster \title Blocking Master Example \ingroup qtserialport-examples - \brief Explains how to use the synchronous API of QSerialPort. + \brief Shows how to use the synchronous API of QSerialPort in a worker thread. - The blocking master example shows how to create an application for a - serial interface using the synchronous API of QSerialPort in a worker - thread. + \e{Blocking Master} shows how to create an application for a serial + interface using the synchronous API of QSerialPort in a worker thread. - \image blockingmaster-example.png Screenshot of the blocking master example + \image blockingmaster-example.png QSerialPort supports two programming alternatives: @@ -162,4 +162,6 @@ \snippet blockingmaster/masterthread.cpp 13 \sa {Terminal Example}, {Blocking Slave Example} + + \include examples-run.qdocinc */ diff --git a/examples/serialport/doc/blockingslave.qdoc b/examples/serialport/doc/blockingslave.qdoc index df35bfc0..a2e3a6b1 100644 --- a/examples/serialport/doc/blockingslave.qdoc +++ b/examples/serialport/doc/blockingslave.qdoc @@ -1,6 +1,7 @@ /**************************************************************************** ** ** Copyright (C) 2011 - 2012 Denis Shienkov +** 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,11 +30,12 @@ \example blockingslave \title Blocking Slave Example \ingroup qtserialport-examples + \brief Shows how to use the synchronous API of QSerialPort in a non-GUI thread. - The Blocking Slave example shows how to create a application for a - serial interface using QSerialPort's synchronous API in a non-GUI thread. + \e{Blocking Slave} shows how to create an application for a serial interface + using QSerialPort's synchronous API in a non-GUI thread. - \image blockingslave-example.png Screenshot of the Blocking Slave example + \image blockingslave-example.png QSerialPort supports two general programming approaches: @@ -160,4 +162,6 @@ \snippet blockingslave/slavethread.cpp 13 \sa {Terminal Example}, {Blocking Master Example} + + \include examples-run.qdocinc */ diff --git a/examples/serialport/doc/cenumerator.qdoc b/examples/serialport/doc/cenumerator.qdoc index 0766931a..83718982 100644 --- a/examples/serialport/doc/cenumerator.qdoc +++ b/examples/serialport/doc/cenumerator.qdoc @@ -1,6 +1,7 @@ /**************************************************************************** ** ** Copyright (C) 2012 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. @@ -28,18 +29,19 @@ /*! \example cenumerator \title Command Line Enumerator Example - \ingroup qtserialport-examples + \ingroup qtserialport-example + \brief Shows how to get information about serial devices in a system. - The Command Line Enumerator example shows how to use the class - QSerialPortInfo for getting information about serial devices that are present - in the system. + \e{Command Line Enumerator} shows how to use the class QSerialPortInfo for + getting information about serial devices that are present in the system. - \image cenumerator-example.png Screenshot of the Command Line Enumerator - example + \image cenumerator-example.png This command line example displays information about serial ports in a console, provided by the class QSerialPortInfo. For getting information about the available ports, use the static method \l{QSerialPortInfo::availablePorts()}{availablePorts()}. + + \include examples-run.qdocinc */ diff --git a/examples/serialport/doc/creaderasync.qdoc b/examples/serialport/doc/creaderasync.qdoc index a8b21013..ff5e9c61 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 */ 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 */ diff --git a/examples/serialport/doc/cwriterasync.qdoc b/examples/serialport/doc/cwriterasync.qdoc index 884435bc..b10f2aaf 100644 --- a/examples/serialport/doc/cwriterasync.qdoc +++ b/examples/serialport/doc/cwriterasync.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,13 +30,13 @@ \example cwriterasync \title Command Line Writer Async Example \ingroup qtserialport-examples + \brief Shows how to send data asynchronously over serial port. - The Command Line Writer Async example shows how to use the QSerialPort class - for sending data asynchronously over the selected serial port with the - desired settings. + \e{Command Line Writer Async} shows how to use the QSerialPort class for + sending data asynchronously over the selected serial port with the desired + settings. - \image cwriterasync-example.png Screenshot of the Command Line Writer Async - example + \image cwriterasync-example.png This command line writer async example sends data asynchronously over the selected serial port in a console, provided by the QSerialPort class. @@ -43,4 +44,6 @@ For sending data asynchronously over the selected serial port, use the \l{QIODevice::write()}{write()} method and \l{QIODevice::bytesWritten()}{bytesWritten()} signal. + + \include examples-run.qdocinc */ diff --git a/examples/serialport/doc/cwritersync.qdoc b/examples/serialport/doc/cwritersync.qdoc index 05858ef7..03086e05 100644 --- a/examples/serialport/doc/cwritersync.qdoc +++ b/examples/serialport/doc/cwritersync.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 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 */ diff --git a/examples/serialport/doc/enumerator.qdoc b/examples/serialport/doc/enumerator.qdoc index 0847d8a8..326fdb4b 100644 --- a/examples/serialport/doc/enumerator.qdoc +++ b/examples/serialport/doc/enumerator.qdoc @@ -1,6 +1,7 @@ /**************************************************************************** ** ** Copyright (C) 2011 - 2012 Denis Shienkov +** 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,15 +30,18 @@ \example enumerator \title Enumerator Example \ingroup qtserialport-examples + \brief Shows how to display information about serial devices in a system. - The Enumerator example shows how to use the class QSerialPortInfo for + \e Enumerator shows how to use the class QSerialPortInfo for getting information about serial devices that are present in the system. - \image enumerator-example.png Screenshot of the Enumerator example + \image enumerator-example.png This GUI example displays information about serial ports in a widget, provided by the class QSerialPortInfo. For getting information about the available ports, use the static method \l{QSerialPortInfo::availablePorts()}{availablePorts()}. + + \include examples-run.qdocinc */ diff --git a/examples/serialport/doc/terminal.qdoc b/examples/serialport/doc/terminal.qdoc index ed8fa023..423d6108 100644 --- a/examples/serialport/doc/terminal.qdoc +++ b/examples/serialport/doc/terminal.qdoc @@ -1,6 +1,7 @@ /**************************************************************************** ** ** Copyright (C) 2011 - 2012 Denis Shienkov +** 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,11 +30,12 @@ \example terminal \title Terminal Example \ingroup qtserialport-examples + \brief Shows how to use various features of QSerialPort. - The Terminal example shows how to create a terminal for a simple serial - interface by using Qt Serial Port. + \e Terminal shows how to create a terminal for a simple serial interface by + using \l{Qt Serial Port}. - \image terminal-example.png Screenshot of the Terminal example + \image terminal-example.png This example shows the main features of the QSerialPort class, like configuration, I/O implementation and so forth. Also, the class @@ -143,4 +145,6 @@ port. \sa {Blocking Slave Example} + + \include examples-run.qdocinc */ diff --git a/examples/serialport/examples.qdoc b/examples/serialport/examples.qdoc index 6e5f3c4a..51858b97 100644 --- a/examples/serialport/examples.qdoc +++ b/examples/serialport/examples.qdoc @@ -2,6 +2,7 @@ ** ** Copyright (C) 2011-2012 Denis Shienkov ** Copyright (C) 2012 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. @@ -28,21 +29,17 @@ /*! \title Qt Serial Port Examples - \page examples.html + \group qtserialport-examples \brief List of serial port examples - The module provides the following examples for reference to - help understand the API usage: + The \l{Qt Serial Port} module provides the following examples for reference + to help understand the API usage. + + \section1 Running the Examples + + To run the examples from \l{Qt Creator Manual}{Qt Creator}, open the \gui + Welcome mode and select the example from \gui Examples. + For more information, visit + \l{Qt Creator: Building and Running an Example}{Building and Running an Example}. - \list - \li \l blockingmaster - \li \l blockingslave - \li \l cenumerator - \li \l cwriterasync - \li \l cwritersync - \li \l creaderasync - \li \l creadersync - \li \l enumerator - \li \l terminal - \endlist */ -- cgit v1.2.3