From 36dc731ff495426a68991a4582f8e1a118d0647c Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Wed, 24 Oct 2018 12:54:02 +0200 Subject: Doc: Fix landing page title Commit 261e4c6 exposed a problem with the landing page by modifying its HTML filename: Landing page has a different title than what's defined in qtdeviceutilities.qdocconf. Until 261e4c6, the TOC was built corrently because the default index filename (index.html) was correct. Fix the landing page title using the provided macro '\maintitle'. Task-number: QTBUG-71198 Change-Id: I37d219d24e8d0395517f75c230942b3733ce31aa Reviewed-by: Mikko Gronoff Reviewed-by: Leena Miettinen --- src/doc/src/qtdeviceutilities-index.qdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/doc/src/qtdeviceutilities-index.qdoc b/src/doc/src/qtdeviceutilities-index.qdoc index af4d26e..ed07853 100644 --- a/src/doc/src/qtdeviceutilities-index.qdoc +++ b/src/doc/src/qtdeviceutilities-index.qdoc @@ -27,7 +27,7 @@ /*! \page qtdeviceutilities-index.html - \title Qt Device Utilities + \maintitle \brief Provides functionality that is useful for embedded applications. \section1 Getting Started -- cgit v1.2.3 From 6e316ceadf15b4af01eb1f5db1a2a36eee5766cb Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Wed, 24 Oct 2018 12:57:58 +0200 Subject: Doc: Fix typo in file name qtdeviceutitilies-module-cpp.qdoc -> qtdeviceutilities-module-cpp.qdoc Change-Id: Ic9727ac2b532ac7d33b026655b2af98a5ff4d25c Reviewed-by: Leena Miettinen --- src/doc/src/qtdeviceutilities-module-cpp.qdoc | 48 +++++++++++++++++++++++++++ src/doc/src/qtdeviceutitilies-module-cpp.qdoc | 48 --------------------------- 2 files changed, 48 insertions(+), 48 deletions(-) create mode 100644 src/doc/src/qtdeviceutilities-module-cpp.qdoc delete mode 100644 src/doc/src/qtdeviceutitilies-module-cpp.qdoc diff --git a/src/doc/src/qtdeviceutilities-module-cpp.qdoc b/src/doc/src/qtdeviceutilities-module-cpp.qdoc new file mode 100644 index 0000000..caa9346 --- /dev/null +++ b/src/doc/src/qtdeviceutilities-module-cpp.qdoc @@ -0,0 +1,48 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** 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 The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \module QtDeviceUtilities + \title Qt Device Utilities C++ Classes + \brief Provides classes that are useful for embedded applications. + \ingroup modules + + \qtvariable deviceutilities + + To include the definitions of the module's classes, use the following + directive: + + \badcode + #include + \endcode + + To link against the module, add this line to your qmake .pro file: + + \badcode + QT += qtdeviceutilities + \endcode +*/ diff --git a/src/doc/src/qtdeviceutitilies-module-cpp.qdoc b/src/doc/src/qtdeviceutitilies-module-cpp.qdoc deleted file mode 100644 index caa9346..0000000 --- a/src/doc/src/qtdeviceutitilies-module-cpp.qdoc +++ /dev/null @@ -1,48 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2018 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** 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 The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \module QtDeviceUtilities - \title Qt Device Utilities C++ Classes - \brief Provides classes that are useful for embedded applications. - \ingroup modules - - \qtvariable deviceutilities - - To include the definitions of the module's classes, use the following - directive: - - \badcode - #include - \endcode - - To link against the module, add this line to your qmake .pro file: - - \badcode - QT += qtdeviceutilities - \endcode -*/ -- cgit v1.2.3