From c7915779e113e270a1fd862eda375aa8ffcbbf4a Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@digia.com>
Date: Wed, 29 May 2013 11:01:22 +0200
Subject: [PATCH] Doc: Fix various problems in Qt Quick Dialogs documentation
This change fixes the following things in .qdocconf:
- CamelCase for project name (required for generating valid tags
in example manifest file).
- Proper selector for QML Types topic
- Fix exampledirs to not pull in all the Qt Quick examples
- Add examplesinstallpath to make Qt Creator see the examples
Also fixes the paths in example docs according to changed exampledirs.
Change-Id: If18f7b5a3160d85814d508e1cbfb7bdb1a002c54
Reviewed-by: Caroline Chao <caroline.chao@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com>
---
.../doc/src/colorandfiledialogs.qdoc | 4 +-
.../dialogs/doc/qtquickdialogs.qdocconf | 38 ++++++++++---------
2 files changed, 22 insertions(+), 20 deletions(-)
diff --git a/examples/quick/dialogs/colorandfiledialogs/doc/src/colorandfiledialogs.qdoc b/examples/quick/dialogs/colorandfiledialogs/doc/src/colorandfiledialogs.qdoc
index e3d021dba8..68804649a9 100644
--- a/examples/quick/dialogs/colorandfiledialogs/doc/src/colorandfiledialogs.qdoc
+++ b/examples/quick/dialogs/colorandfiledialogs/doc/src/colorandfiledialogs.qdoc
@@ -36,9 +36,9 @@
A \l FileDialog is used to choose a single file, multiple files or a
single directory, depending on how it is configured.
- \snippet dialogs/colorandfiledialogs/FileDialogs.qml filedialog
+ \snippet colorandfiledialogs/FileDialogs.qml filedialog
A \l ColorDialog is used to choose a color, with or without alpha (transparency)
depending on how it is configured.
- \snippet dialogs/colorandfiledialogs/ColorDialogs.qml colordialog
+ \snippet colorandfiledialogs/ColorDialogs.qml colordialog
*/
diff --git a/src/imports/dialogs/doc/qtquickdialogs.qdocconf b/src/imports/dialogs/doc/qtquickdialogs.qdocconf
index 8a4435cd41..5caa1c0588 100644
--- a/src/imports/dialogs/doc/qtquickdialogs.qdocconf
+++ b/src/imports/dialogs/doc/qtquickdialogs.qdocconf
@@ -5,31 +5,33 @@ description = Qt Quick Dialogs Reference Documentation
url = http://qt-project.org/doc/qt-$QT_VER/qtquickdialogs/
version = $QT_VERSION
-qhp.projects = qtquickdialogs
+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.indexRoot =
+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.indexRoot =
-qhp.qtquickdialogs.filterAttributes = qtquickdialogs $QT_VERSION qtrefdoc
-qhp.qtquickdialogs.customFilters.Qt.name = QtQuickDialogs $QT_VERSION
-qhp.qtquickdialogs.customFilters.Qt.filterAttributes = qtquickdialogs $QT_VERSION
+qhp.QtQuickDialogs.filterAttributes = qtquickdialogs $QT_VERSION qtrefdoc
+qhp.QtQuickDialogs.customFilters.Qt.name = QtQuickDialogs $QT_VERSION
+qhp.QtQuickDialogs.customFilters.Qt.filterAttributes = qtquickdialogs $QT_VERSION
-qhp.qtquickdialogs.subprojects = qtquickdialogsqmltypes
-qhp.qtquickdialogs.subprojects.qtquickdialogsqmltypes.title = QML Types
-qhp.qtquickdialogs.subprojects.qtquickdialogsqmltypes.indexTitle = Qt Quick Dialogs
-qhp.qtquickdialogs.subprojects.qtquickdialogsqmltypes.selectors = class fake:headerfile
-qhp.qtquickdialogs.subprojects.qtquickdialogsqmltypes.sortPages = true
-qhp.qtquickdialogs.subprojects.qtquickdialogsqmltypes.type = manual
+qhp.QtQuickDialogs.subprojects = qtquickdialogsqmltypes
+qhp.QtQuickDialogs.subprojects.qtquickdialogsqmltypes.title = QML Types
+qhp.QtQuickDialogs.subprojects.qtquickdialogsqmltypes.indexTitle = Qt Quick Dialogs
+qhp.QtQuickDialogs.subprojects.qtquickdialogsqmltypes.selectors = fake:qmlclass
+qhp.QtQuickDialogs.subprojects.qtquickdialogsqmltypes.sortPages = true
+qhp.QtQuickDialogs.subprojects.qtquickdialogsqmltypes.type = manual
depends = qtqml qtquick qtgui qtwidgets qtdoc
-exampledirs += ../../../../examples/quick/
+exampledirs += ../../../../examples/quick/dialogs
-headerdirs += ../
+examplesinstallpath = quick/dialogs
-sourcedirs += ../
+headerdirs += ..
+
+sourcedirs += ..
imagedirs += images
--
GitLab