diff options
author | Topi Reinio <topi.reinio@digia.com> | 2015-01-19 15:09:57 +0100 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@digia.com> | 2015-01-20 09:25:39 +0100 |
commit | 39686161748c665780a276a7e309feb0e4a6e440 (patch) | |
tree | 98d2658d94e4df1be9d8fc29a4e6f614ec2bb65c /src/serialport | |
parent | 4999ce5fb04986ed1eb7fcc2f6d04ae53529b071 (diff) | |
download | qtserialport-39686161748c665780a276a7e309feb0e4a6e440.tar.gz |
Doc: Fix the examples page
The group page listing all the examples defined also
a \page name, which caused the generated page to
contain no examples.
Also correct the group name for Command Line Enumerator
Example, and move the qtserialport-examples.qdoc to
the correct location.
Change-Id: I6ebfbe1c49d2a44e4ed631f22027659ba43ceb8d
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Diffstat (limited to 'src/serialport')
-rw-r--r-- | src/serialport/doc/src/qtserialport-examples.qdoc | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/src/serialport/doc/src/qtserialport-examples.qdoc b/src/serialport/doc/src/qtserialport-examples.qdoc new file mode 100644 index 0000000..51858b9 --- /dev/null +++ b/src/serialport/doc/src/qtserialport-examples.qdoc @@ -0,0 +1,45 @@ +/**************************************************************************** +** +** Copyright (C) 2011-2012 Denis Shienkov <denis.shienkov@gmail.com> +** Copyright (C) 2012 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. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \title Qt Serial Port Examples + \group qtserialport-examples + \brief List of serial port examples + + 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}. + +*/ |