diff options
Diffstat (limited to 'src/quick/doc/qtquick.qdocconf')
| -rw-r--r-- | src/quick/doc/qtquick.qdocconf | 137 |
1 files changed, 84 insertions, 53 deletions
diff --git a/src/quick/doc/qtquick.qdocconf b/src/quick/doc/qtquick.qdocconf index b1268097fc..deda199b96 100644 --- a/src/quick/doc/qtquick.qdocconf +++ b/src/quick/doc/qtquick.qdocconf @@ -1,4 +1,5 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) +include($QT_INSTALL_DOCS/config/exampleurl-qtdeclarative.qdocconf) project = QtQuick description = Qt Quick Reference Documentation @@ -18,9 +19,6 @@ qhp.QtQuick.virtualFolder = qtquick qhp.QtQuick.indexTitle = Qt Quick qhp.QtQuick.indexRoot = -qhp.QtQuick.filterAttributes = qtquick $QT_VERSION qtrefdoc -qhp.QtQuick.customFilters.Qt.name = QtQuick $QT_VERSION -qhp.QtQuick.customFilters.Qt.filterAttributes = qtquick $QT_VERSION qhp.QtQuick.subprojects = qmltypes classes examples qhp.QtQuick.subprojects.qmltypes.title = QML Types qhp.QtQuick.subprojects.qmltypes.indexTitle = Qt Quick QML Types @@ -29,60 +27,85 @@ 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 - -tagfile = ../../../doc/qtquick/qtquick.tags - -depends += qtcore qtqml qtqmltest qtgui qtlinguist qtquickcontrols1 qtquickcontrols qtdoc qtquickdialogs qtsensors qtwidgets qmake qtmultimedia qtgraphicaleffects qtsql qtxmlpatterns - -headerdirs += ..\ - ../../quickwidgets - -sourcedirs += .. \ - ../../imports/testlib \ - ../../quickwidgets - -exampledirs += ../../../examples/quick \ - snippets - - -imagedirs += images - -#add particles and shapes sources -headerdirs += ../../particles \ - ../../quickshapes -sourcedirs += ../../particles \ - ../../quickshapes - -#add imports directory because of dependencies -headerdirs += ../../imports -sourcedirs += ../../imports - -#add plugins directory because of dependencies -headerdirs += ../../plugins -sourcedirs += ../../plugins - -#exclude certain directories -excludedirs += ../../imports/models \ - ../../imports/statemachine +qhp.QtQuick.subprojects.examples.selectors = doc:example + +tagfile = qtquick.tags + +depends += \ + qtcore \ + qtopengl \ + qtqml \ + qtqmlmodels \ + qtqmlxmllistmodel \ + qtqmltest \ + qtqmlcore \ + qtgui \ + qtlinguist \ + qtquickcontrols \ + qtquick3d \ + qtdoc \ + qtplatformintegration \ + qtwidgets \ + qmake \ + qtsql \ + qtshadertools \ + qtsvg \ + qmake \ + qtcmake \ + qtquickeffectmaker + +{headerdirs,sourcedirs} += \ + .. \ + ../../quick \ + ../../quickwidgets \ + ../../qmllocalstorage \ + ../../quicklayouts \ + ../../labs \ + ../../quick/jar/org/qtproject/qt/android \ + ../../../examples/platforms + +# both have their own documentation project +excludedirs += \ + ../../labs/platform \ + ../../labs/models + +exampledirs += \ + ../../../examples/quick \ + ../../qmlmodels/doc/snippets \ + ../../quickcontrols/doc/snippets \ + snippets \ + ../../../tests/auto/quick/doc \ + ../../../examples/platforms + +imagedirs += images + +# Add particles, shapes and effects sources +{headerdirs,sourcedirs} += \ + ../../particles \ + ../../quickshapes \ + ../../effects \ + ../../quickvectorimage + +# Add imports and plugins directories because of dependencies +{headerdirs,sourcedirs} += \ + ../../imports \ + ../../plugins excludefiles += ../util/qquickpropertychanges_p.h -examples.fileextensions += "*.qm" +examples.fileextensions += "*.qm" \ + "*.java" \ + "*.kt" -manifestmeta.thumbnail.names += "QtQuick/Threaded ListModel Example" \ - "QtQuick/QML Dynamic View Ordering Tutorial*" +manifestmeta.thumbnail.names += "QtQuick/QML Dynamic View Ordering Tutorial*" -manifestmeta.highlighted.names = "QtQuick/Qt Quick Demo - Same Game" \ - "QtQuick/Qt Quick Demo - Photo Surface" \ - "QtQuick/Qt Quick Demo - Tweet Search" \ - "QtQuick/Qt Quick Demo - Calqlatr" \ - "QtQuick/Qt Quick Demo - StocQt" \ - "QtQuick/Qt Quick Demo - Clocks" \ - "QtQuick/Qt Quick Examples - Shader Effects" +# Highlight examples for the Graphics & Multimedia category +manifestmeta.highlighted.names = \ + "QtQuick/Qt Quick Layouts - Responsive Layout Example" \ + "QtQuick/Scene Graph - RHI Under QML" navigation.landingpage = "Qt Quick" navigation.cppclassespage = "Qt Quick C++ Classes" @@ -90,7 +113,15 @@ navigation.qmltypespage = "Qt Quick QML Types" # \svgcolor {#ffdead} macro.svgcolor.HTML = "<div style=\"padding:10px;color:#fff;background:\1;\"></div>" +macro.svgcolor.DocBook = "<db:phrase role=\"color:\1\">          </db:phrase>" + +macro.QQEM = "Qt Quick Effect Maker" + +# YouTube video thumbnail that show up in offline docs +{HTML.extraimages,DocBook.extraFiles,qhp.QtQuick.extraFiles} += images/9BcAYDlpuT8.jpg + +# suppress qdoc warnings for \instantiates entries +spurious += "C\\+\\+ class .*\\\\instantiates .*" -# youtube video thumbnails that show up in offline and online docs -HTML.extraimages += images/9BcAYDlpuT8.jpg -qhp.QtQuick.extraFiles += images/9BcAYDlpuT8.jpg +# Enforce zero documentation warnings +warninglimit = 0 |