From 0c8f2058d88629f94bce2828f6736f874960288f Mon Sep 17 00:00:00 2001 From: Andreas Eliasson Date: Wed, 9 Feb 2022 15:13:27 +0100 Subject: Doc: Fix minor grammar issues Some minor grammar issues found in the qtquickcontrols, qtquickdialogs, and qtquicklayout landing pages. Task-number: QTBUG-100369 Pick-to: 6.3 Change-Id: I36ffbee1ad8bef755cc676285db8629d79d32e13 Reviewed-by: Venugopal Shivashankar --- .../src/concepts/layouts/qtquicklayouts-index.qdoc | 12 +++--- .../concepts/layouts/qtquicklayouts-qmltypes.qdoc | 46 ++++++++++++++++++++++ .../doc/src/concepts/layouts/qtquicklayouts.qdoc | 46 ---------------------- .../doc/src/qtquickcontrols2-index.qdoc | 9 +++-- .../doc/src/qtquickdialogs-index.qdoc | 4 +- 5 files changed, 59 insertions(+), 58 deletions(-) create mode 100644 src/quick/doc/src/concepts/layouts/qtquicklayouts-qmltypes.qdoc delete mode 100644 src/quick/doc/src/concepts/layouts/qtquicklayouts.qdoc diff --git a/src/quick/doc/src/concepts/layouts/qtquicklayouts-index.qdoc b/src/quick/doc/src/concepts/layouts/qtquicklayouts-index.qdoc index 15b8394ebf..cbbaa36c7b 100644 --- a/src/quick/doc/src/concepts/layouts/qtquicklayouts-index.qdoc +++ b/src/quick/doc/src/concepts/layouts/qtquicklayouts-index.qdoc @@ -30,17 +30,17 @@ \title Qt Quick Layouts \brief A module with a set of QML elements that arrange QML items in a user interface. - Qt Quick Layouts are a set of QML types used to arrange items in a user interface. In contrast - to \l{Item Positioners}{positioners}, Qt Quick Layouts can also resize their items. This makes - them well suited for resizable user interfaces. Since layouts are items they can consequently - be nested. + Qt Quick Layouts are a set of QML types used to arrange items in a user + interface. In contrast to \l{Item Positioners}{positioners}, Qt Quick + Layouts can also resize their child items. This makes them well suited for + resizable user interfaces. Visit the \l{Qt Quick Layouts Overview} page to get started. \section1 Using the Module - The QML types can be imported into your application by adding the following - import statement in your \c {.qml} file. + The \l {Qt Quick Layouts QML Types}{QML types} can be imported into your + application by adding the following import statement in your \c {.qml} file. \qml import QtQuick.Layouts diff --git a/src/quick/doc/src/concepts/layouts/qtquicklayouts-qmltypes.qdoc b/src/quick/doc/src/concepts/layouts/qtquicklayouts-qmltypes.qdoc new file mode 100644 index 0000000000..0df832cca9 --- /dev/null +++ b/src/quick/doc/src/concepts/layouts/qtquicklayouts-qmltypes.qdoc @@ -0,0 +1,46 @@ +/**************************************************************************** +** +** Copyright (C) 2016 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$ +** +****************************************************************************/ + +/*! + \qmlmodule QtQuick.Layouts + \title Qt Quick Layouts QML Types + \ingroup qmlmodules + \brief Provides QML types for arranging QML items in a user interface. + + The \l{Qt Quick Layouts} module provides QML types for arranging + QML items in a user interface. + These QML types work in conjunction with \l{Qt Quick} and + \l{Qt Quick Controls}. + + The QML types can be imported into your application using the + following import statement in your .qml file. + + \qml + import QtQuick.Layouts + \endqml + +*/ diff --git a/src/quick/doc/src/concepts/layouts/qtquicklayouts.qdoc b/src/quick/doc/src/concepts/layouts/qtquicklayouts.qdoc deleted file mode 100644 index 0df832cca9..0000000000 --- a/src/quick/doc/src/concepts/layouts/qtquicklayouts.qdoc +++ /dev/null @@ -1,46 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 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$ -** -****************************************************************************/ - -/*! - \qmlmodule QtQuick.Layouts - \title Qt Quick Layouts QML Types - \ingroup qmlmodules - \brief Provides QML types for arranging QML items in a user interface. - - The \l{Qt Quick Layouts} module provides QML types for arranging - QML items in a user interface. - These QML types work in conjunction with \l{Qt Quick} and - \l{Qt Quick Controls}. - - The QML types can be imported into your application using the - following import statement in your .qml file. - - \qml - import QtQuick.Layouts - \endqml - -*/ diff --git a/src/quickcontrols2/doc/src/qtquickcontrols2-index.qdoc b/src/quickcontrols2/doc/src/qtquickcontrols2-index.qdoc index 6de9fa228e..889947019c 100644 --- a/src/quickcontrols2/doc/src/qtquickcontrols2-index.qdoc +++ b/src/quickcontrols2/doc/src/qtquickcontrols2-index.qdoc @@ -38,7 +38,7 @@ \image qtquickcontrols2-styles.png - Qt Quick Controls comes with a selection customizable styles. + Qt Quick Controls comes with a selection of customizable styles. See \l {Styling Qt Quick Controls} for more details. @@ -55,9 +55,10 @@ \section2 C++ API - Using the \l{Qt Quick Controls C++ Classes}{C++ API} requires linking against the module library, - either directly or through other dependencies. - Several build tools have dedicated support for this, including CMake and qmake. + Using the \l{Qt Quick Controls C++ Classes}{C++ API} requires linking + against the module library, either directly or through other dependencies. + Several build tools have dedicated support for this, including CMake and + qmake. \section3 Building with CMake Use the \c find_package() command to locate the needed module components in the Qt6 package: diff --git a/src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-index.qdoc b/src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-index.qdoc index 92a25c3fd4..487d327497 100644 --- a/src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-index.qdoc +++ b/src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-index.qdoc @@ -31,8 +31,8 @@ \brief Provides QML types for creating and interacting with system dialogs. - The Qt Quick Dialogs module allows to create and interact with system dialogs - from QML. The module was introduced in Qt 6.2. + The Qt Quick Dialogs module allows you to create and interact with system + dialogs from QML. The module was introduced in Qt 6.2. \section1 Using the Module -- cgit v1.2.3