diff options
author | Allan Sandfeld Jensen <allan.jensen@qt.io> | 2021-06-01 11:13:53 +0200 |
---|---|---|
committer | Allan Sandfeld Jensen <allan.jensen@qt.io> | 2021-06-08 08:57:46 +0200 |
commit | c43661d01bad15a39c361cf054d0af093d5c0f81 (patch) | |
tree | 70952cd5a7d1624bd82adabdbbe35dcea01de8f8 /src/core/doc | |
parent | 78559d3b0b75270f2719ef312d2583b80f8d9325 (diff) |
Add WebEngine qdocconf for documentation
Probably still needs internal naming updates.
Task-number: QTBUG-94130
Change-Id: I3f2522b16a78475d42f9f689cf2d2e994130cf7b
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/core/doc')
-rw-r--r-- | src/core/doc/QtWebEngineDoc | 3 | ||||
-rw-r--r-- | src/core/doc/qtwebengine.qdocconf | 90 |
2 files changed, 93 insertions, 0 deletions
diff --git a/src/core/doc/QtWebEngineDoc b/src/core/doc/QtWebEngineDoc new file mode 100644 index 000000000..7ab3164fd --- /dev/null +++ b/src/core/doc/QtWebEngineDoc @@ -0,0 +1,3 @@ +#include <QtWebEngineCore/QtWebEngineCore> +#include <QtWebEngineQuick/QtWebEngineQuick> +#include <QtWebEngineWidgets/QtWebEngineWidgets> diff --git a/src/core/doc/qtwebengine.qdocconf b/src/core/doc/qtwebengine.qdocconf new file mode 100644 index 000000000..416f06abb --- /dev/null +++ b/src/core/doc/qtwebengine.qdocconf @@ -0,0 +1,90 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) +include($QT_INSTALL_DOCS/config/exampleurl-qtwebengine.qdocconf) + +project = QtWebEngine +description = Qt WebEngine Reference Documentation +version = $QT_VERSION + +qhp.projects = QtWebEngine + +qhp.QtWebEngine.file = qtwebengine.qhp +qhp.QtWebEngine.namespace = org.qt-project.qtwebengine.$QT_VERSION_TAG +qhp.QtWebEngine.virtualFolder = qtwebengine +qhp.QtWebEngine.indexTitle = Qt WebEngine +qhp.QtWebEngine.indexRoot = + +qhp.QtWebEngine.filterAttributes = qtwebengine $QT_VERSION qtrefdoc +qhp.QtWebEngine.customFilters.Qt.name = QtWebEngine $QT_VERSION +qhp.QtWebEngine.customFilters.Qt.filterAttributes = qtwebengine $QT_VERSION + +qhp.QtWebEngine.subprojects = classes qmltypes examples + +qhp.QtWebEngine.subprojects.classes.title = C++ Classes and Namespaces +qhp.QtWebEngine.subprojects.classes.indexTitle = Qt WebEngine C++ Classes and Namespaces +qhp.QtWebEngine.subprojects.classes.selectors = class group:qtwebengine-namespaces doc:headerfile +qhp.QtWebEngine.subprojects.classes.sortPages = true + +qhp.QtWebEngine.subprojects.qmltypes.title = QML Types +qhp.QtWebEngine.subprojects.qmltypes.indexTitle = Qt WebEngine QML Types +qhp.QtWebEngine.subprojects.qmltypes.selectors = qmltype +qhp.QtWebEngine.subprojects.qmltypes.sortPages = true + +qhp.QtWebEngine.subprojects.examples.title = Examples +qhp.QtWebEngine.subprojects.examples.indexTitle = Qt WebEngine Examples +qhp.QtWebEngine.subprojects.examples.selectors = doc:example +qhp.QtWebEngine.subprojects.examples.sortPages = true + +manifestmeta.highlighted.names += "QtWebEngine/WebEngine Widgets Simple Browser Example" \ + "QtWebEngine/WebEngine Quick Nano Browser" + +tagfile = ../../../doc/qtwebengine/qtwebengine.tags + +# Custom module header for clang that pulls in also QtWebEngineWidgets +moduleheader = QtWebEngineDoc + +# Additional include paths for clang +includepaths += -I . + +depends += qtcore \ + qtgui \ + qtlocation \ + qtnetwork \ + qtplatformheaders \ + qtprintsupport \ + qtpositioning \ + qtqml \ + qtquick \ + qtquickcontrols \ + qtdoc \ + qtwebchannel \ + qtwebview \ + qtwidgets + +headerdirs += ../../core/api \ + ../../webenginequick/api \ + ../../webenginewidgets/api + +sourcedirs = ../../core/api \ + ../../core/doc \ + ../../webenginequick/api \ + ../../webenginequick/doc \ + ../../webenginewidgets/api \ + ../../webenginewidgets/doc + +exampledirs += ../../../examples \ + ../../core/doc/snippets \ + ../../webenginequick/doc/snippets \ + ../../webenginewidgets/doc/snippets + +examples.fileextensions += *.aff *.dic *.html + +imagedirs += images + +navigation.landingpage = "Qt WebEngine" +navigation.cppclassespage = "Qt WebEngine C++ Classes and Namespaces" +navigation.qmltypespage = "Qt WebEngine QML Types" + +# \QWE macro expands to 'Qt WebEngine' without auto-linking anywhere. +macro.QWE = "Qt \\WebEngine" + +Cpp.ignoretokens += Q_WEBENGINE_EXPORT Q_WEBENGINECORE_EXPORT QWEBENGINEWIDGETS_EXPORT |