aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2021-09-02 12:06:18 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2021-09-03 15:10:43 +0000
commit5e16641b777f0ad27ac3dfc07bc8ebfbd4c00031 (patch)
treea3e996f6f4f1b2ea945aa09d3ceb399f52c7f9be /src
parent067253fb2f1aec3e03c577dd53ed2e6d903c28da (diff)
Doc: Fix documentation warnings in qtdeclarative
* QtLabsPlatform has its own documentation project, but its source directory was pulled into QtQuick docs, causing duplicate generation and warnings. * Fix \snippet paths for files that were renamed/moved around. * Clean up .qdocconf files, use the {,} syntax to set identical values for multiple variables. * Fix incorrect \sa link. Fixes: QTBUG-96125 Change-Id: I4c83787ac23a5b40019c74d46ee87c968a8d4907 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> (cherry picked from commit 5e6777be1d793740c184b4f49536b12fd83735b1) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src')
-rw-r--r--src/labs/platform/doc/qtlabsplatform.qdocconf3
-rw-r--r--src/qml/doc/src/cppintegration/extending-tutorial.qdoc2
-rw-r--r--src/quick/doc/qtquick.qdocconf44
3 files changed, 24 insertions, 25 deletions
diff --git a/src/labs/platform/doc/qtlabsplatform.qdocconf b/src/labs/platform/doc/qtlabsplatform.qdocconf
index 54ed82046d..8f64cae794 100644
--- a/src/labs/platform/doc/qtlabsplatform.qdocconf
+++ b/src/labs/platform/doc/qtlabsplatform.qdocconf
@@ -28,8 +28,7 @@ depends = qtcore qtgui qtdoc qtqml qtqmlmodels qtquick qtquickcontrols qtwidgets
# This module has no documented C++ types, clear the module header
moduleheader =
-headerdirs += ../
-sourcedirs += ../
+{headerdirs,sourcedirs} += ..
imagedirs += images
diff --git a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc
index 6e6d067ba6..78ad39c403 100644
--- a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc
+++ b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc
@@ -413,7 +413,7 @@ plugin binary is copied to \c Contents/PlugIns in the the application bundle;
this path is set in \c {chapter6-plugins/app.pro}:
\quotefromfile tutorials/extending-qml/chapter6-plugins/app.pro
-\skipto osx
+\skipto macos
\printuntil }
To account for this, we also need to add this location as a
diff --git a/src/quick/doc/qtquick.qdocconf b/src/quick/doc/qtquick.qdocconf
index 12ee620fd8..26687784a8 100644
--- a/src/quick/doc/qtquick.qdocconf
+++ b/src/quick/doc/qtquick.qdocconf
@@ -30,13 +30,13 @@ qhp.QtQuick.subprojects.qmltypes.sortPages = true
qhp.QtQuick.subprojects.classes.title = Classes
qhp.QtQuick.subprojects.classes.title = C++ Classes
qhp.QtQuick.subprojects.classes.indexTitle = Qt Quick C++ Classes
-qhp.QtQuick.subprojects.classes.selectors = class fake:headerfile
+qhp.QtQuick.subprojects.classes.selectors = class doc:headerfile
qhp.QtQuick.subprojects.classes.sortPages = true
qhp.QtQuick.subprojects.examples.title = Examples
qhp.QtQuick.subprojects.examples.indexTitle = Qt Quick Examples and Tutorials
-qhp.QtQuick.subprojects.examples.selectors = fake:example
+qhp.QtQuick.subprojects.examples.selectors = doc:example
-tagfile = ../../../doc/qtquick/qtquick.tags
+tagfile = qtquick.tags
depends += \
qtcore \
@@ -58,34 +58,35 @@ depends += \
qtcmake
{headerdirs,sourcedirs} += \
- ..\
+ .. \
../../quick \
../../quickwidgets \
../../qmllocalstorage \
../../quicklayouts \
../../labs
-exampledirs += ../../../examples/quick \
- snippets
+# src/labs/platform has its own documentation project
+excludedirs += ../../labs/platform
-imagedirs += images
+exampledirs += \
+ ../../../examples/quick \
+ ../../qmlmodels/doc/snippets \
+ snippets
-#add particles and shapes sources
-headerdirs += ../../particles \
- ../../quickshapes
-sourcedirs += ../../particles \
- ../../quickshapes
+imagedirs += images
-#add imports directory because of dependencies
-headerdirs += ../../imports
-sourcedirs += ../../imports
+# Add particles and shapes sources
+{headerdirs,sourcedirs} += \
+ ../../particles \
+ ../../quickshapes
-#add plugins directory because of dependencies
-headerdirs += ../../plugins
-sourcedirs += ../../plugins
+# Add imports and plugins directories because of dependencies
+{headerdirs,sourcedirs} += \
+ ../../imports \
+ ../../plugins
excludefiles += ../util/qquickpropertychanges_p.h
-examples.fileextensions += "*.qm"
+examples.fileextensions += "*.qm"
manifestmeta.thumbnail.names += "QtQuick/Threaded ListModel Example" \
"QtQuick/QML Dynamic View Ordering Tutorial*"
@@ -99,6 +100,5 @@ navigation.qmltypespage = "Qt Quick QML Types"
# \svgcolor {#ffdead}
macro.svgcolor.HTML = "<div style=\"padding:10px;color:#fff;background:\1;\"></div>"
-# youtube video thumbnails that show up in offline and online docs
-HTML.extraimages += images/9BcAYDlpuT8.jpg
-qhp.QtQuick.extraFiles += images/9BcAYDlpuT8.jpg
+# YouTube video thumbnail that show up in offline docs
+{HTML.extraimages,qhp.QtQuick.extraFiles} += images/9BcAYDlpuT8.jpg