From c43661d01bad15a39c361cf054d0af093d5c0f81 Mon Sep 17 00:00:00 2001
From: Allan Sandfeld Jensen <allan.jensen@qt.io>
Date: Tue, 1 Jun 2021 11:13:53 +0200
Subject: 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>
---
 src/core/api/CMakeLists.txt       |  4 ++
 src/core/doc/QtWebEngineDoc       |  3 ++
 src/core/doc/qtwebengine.qdocconf | 90 +++++++++++++++++++++++++++++++++++++++
 3 files changed, 97 insertions(+)
 create mode 100644 src/core/doc/QtWebEngineDoc
 create mode 100644 src/core/doc/qtwebengine.qdocconf

(limited to 'src/core')

diff --git a/src/core/api/CMakeLists.txt b/src/core/api/CMakeLists.txt
index 660473600..6d9e614d2 100644
--- a/src/core/api/CMakeLists.txt
+++ b/src/core/api/CMakeLists.txt
@@ -74,3 +74,7 @@ qt_internal_extend_target(WebEngineCore CONDITION QT_FEATURE_webengine_geolocati
     PUBLIC_LIBRARIES
         Qt::Positioning
 )
+
+qt_internal_add_docs(WebEngineCore
+    ../doc/qtwebengine.qdocconf
+)
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
-- 
cgit v1.2.3