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/terminal.qdoc | |
parent | 55b29ef40df2b1f91ecab06c492ca70ba5e0297f (diff) |
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/terminal.qdoc')
-rw-r--r-- | examples/serialport/doc/terminal.qdoc | 10 |
1 files changed, 7 insertions, 3 deletions
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 <denis.shienkov@gmail.com> +** 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 */ |