From 39686161748c665780a276a7e309feb0e4a6e440 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Mon, 19 Jan 2015 15:09:57 +0100 Subject: 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 Reviewed-by: Sergey Belyashov Reviewed-by: Leena Miettinen --- examples/serialport/doc/cenumerator.qdoc | 2 +- examples/serialport/examples.qdoc | 46 ----------------------- src/serialport/doc/src/qtserialport-examples.qdoc | 45 ++++++++++++++++++++++ 3 files changed, 46 insertions(+), 47 deletions(-) delete mode 100644 examples/serialport/examples.qdoc create mode 100644 src/serialport/doc/src/qtserialport-examples.qdoc diff --git a/examples/serialport/doc/cenumerator.qdoc b/examples/serialport/doc/cenumerator.qdoc index 8371898..6774eed 100644 --- a/examples/serialport/doc/cenumerator.qdoc +++ b/examples/serialport/doc/cenumerator.qdoc @@ -29,7 +29,7 @@ /*! \example cenumerator \title Command Line Enumerator Example - \ingroup qtserialport-example + \ingroup qtserialport-examples \brief Shows how to get information about serial devices in a system. \e{Command Line Enumerator} shows how to use the class QSerialPortInfo for diff --git a/examples/serialport/examples.qdoc b/examples/serialport/examples.qdoc deleted file mode 100644 index e8e4c2b..0000000 --- a/examples/serialport/examples.qdoc +++ /dev/null @@ -1,46 +0,0 @@ -/**************************************************************************** -** -** 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. -** -** $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 - \page examples-serialport.html - \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}. - -*/ 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 +** 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. +** +** $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}. + +*/ -- cgit v1.2.1