From b01b4f00eae8022c6a97d90f54dac395144ae095 Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@qt.io>
Date: Wed, 7 Jul 2021 13:25:31 +0200
Subject: Doc: Add missing QML module page for Qt Quick Dialogs

And fix minor documentation issues.

Pick-to: 6.2
Change-Id: I42f13e5662fb4e4127428b5e67a145ed22be4cfd
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
---
 .../quickdialogs2/doc/qtquickdialogs.qdocconf      |  7 ++--
 .../doc/src/qtquickdialogs-module.qdoc             | 44 ++++++++++++++++++++++
 .../quickdialogs2/qquickfiledialog.cpp             |  5 ++-
 3 files changed, 52 insertions(+), 4 deletions(-)
 create mode 100644 src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-module.qdoc

(limited to 'src')

diff --git a/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf b/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf
index e53a5c22..87296d6f 100644
--- a/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf
+++ b/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf
@@ -10,7 +10,7 @@ qhp.projects            = QtQuickDialogs
 qhp.QtQuickDialogs.file          = qtquickdialogs.qhp
 qhp.QtQuickDialogs.namespace     = org.qt-project.qtquickdialogs.$QT_VERSION_TAG
 qhp.QtQuickDialogs.virtualFolder = qtquickdialogs
-qhp.QtQuickDialogs.indexTitle    = Qt Quick Dialogs
+qhp.QtQuickDialogs.indexTitle    = Qt Quick Dialogs QML Types
 qhp.QtQuickDialogs.indexRoot     =
 
 qhp.QtQuickDialogs.filterAttributes                  = qtquickdialogs $QT_VERSION qtrefdoc
@@ -34,7 +34,8 @@ sourcedirs += .. \
 
 imagedirs += images
 
-navigation.landingpage  = "Qt Quick Dialogs"
-navigation.qmltypespage = "Qt Quick Dialogs QML Types"
+navigation.landingpage   = "Qt Quick Dialogs QML Types"
+navigation.landingtitle  = "Qt Quick Dialogs"
+navigation.qmltypespage  = "Qt Quick Dialogs QML Types"
 
 tagfile                 = qtquickdialogs.tags
diff --git a/src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-module.qdoc b/src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-module.qdoc
new file mode 100644
index 00000000..4ee8b8b1
--- /dev/null
+++ b/src/quickdialogs2/quickdialogs2/doc/src/qtquickdialogs-module.qdoc
@@ -0,0 +1,44 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 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.Dialogs
+    \title Qt Quick Dialogs QML Types
+    \brief Provides native dialogs with a Qt Quick fallback on platforms that
+            do not provide a native implementation.
+    \since 6.2
+
+    \include includes/fallback.qdocinc
+
+    To use types in this module, use the following import statement:
+
+    \badcode
+    import QtQuick.Dialogs
+    \endcode
+
+    \section1 QML Types
+*/
diff --git a/src/quickdialogs2/quickdialogs2/qquickfiledialog.cpp b/src/quickdialogs2/quickdialogs2/qquickfiledialog.cpp
index f63cbbf0..a8df0bd6 100644
--- a/src/quickdialogs2/quickdialogs2/qquickfiledialog.cpp
+++ b/src/quickdialogs2/quickdialogs2/qquickfiledialog.cpp
@@ -96,7 +96,7 @@ Q_LOGGING_CATEGORY(lcFileDialog, "qt.quick.dialogs.filedialog")
 
     \include includes/fallback.qdocinc
 
-    \sa FolderDialog, StandardPaths
+    //! \sa FolderDialog, StandardPaths
 */
 
 Q_DECLARE_LOGGING_CATEGORY(lcDialogs)
@@ -259,9 +259,12 @@ void QQuickFileDialog::setCurrentFiles(const QList<QUrl> &currentFiles)
     This property holds the folder where files are selected. It can be set to
     control the initial directory that is shown when the dialog is opened.
 
+//! TODO: Remove \omit once FolderDialog is available
+\omit
     For selecting a folder, use FolderDialog instead.
 
     \sa FolderDialog
+\endomit
 */
 QUrl QQuickFileDialog::currentFolder() const
 {
-- 
cgit v1.2.3