diff options
author | Topi Reinio <topi.reinio@qt.io> | 2021-09-02 12:06:18 +0200 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2021-09-03 10:16:39 +0200 |
commit | 5e6777be1d793740c184b4f49536b12fd83735b1 (patch) | |
tree | 7e1e8378d2d064d7db44eea200775eebff68e67a /src/quick/doc/qtquick.qdocconf | |
parent | b262090c0226589282c377fe531cd3a1e713c729 (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.
Pick-to: 6.2
Fixes: QTBUG-96125
Change-Id: I4c83787ac23a5b40019c74d46ee87c968a8d4907
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Diffstat (limited to 'src/quick/doc/qtquick.qdocconf')
-rw-r--r-- | src/quick/doc/qtquick.qdocconf | 44 |
1 files changed, 22 insertions, 22 deletions
diff --git a/src/quick/doc/qtquick.qdocconf b/src/quick/doc/qtquick.qdocconf index a22f972c56..7836fc9e0f 100644 --- a/src/quick/doc/qtquick.qdocconf +++ b/src/quick/doc/qtquick.qdocconf @@ -27,13 +27,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 \ @@ -55,34 +55,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*" @@ -96,6 +97,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 |