CMake: Build docs for Qt 3D

In order to pass correct Qt include paths to QDoc's Clang-based C++
parser, move the documentation project to be under src/core.

Pick-to: 6.0 6.0.0
Fixes: QTBUG-88838
Change-Id: Ie1608eb295d94f20ef0089f73f3df1aceb566c14
Reviewed-by: Paul Wicking <paul.wicking@qt.io>

44 files changed, 82 insertions, 102 deletions

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index b0552cc04..a4a742fdc 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -16,7 +16,6 @@ endif()
 if(QT_FEATURE_qt3d_animation)
     add_subdirectory(animation)
 endif()
-add_subdirectory(doc)
 
 if(TARGET Qt::Quick)
     # Quick3D libs
diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt
index eaecab0ee..561d919c9 100644
--- a/src/core/CMakeLists.txt
+++ b/src/core/CMakeLists.txt
@@ -185,3 +185,7 @@ qt_internal_extend_target(3DCore
         aligned_malloc_p.h
         resources/qresourcemanager.cpp resources/qresourcemanager_p.h
 )
+
+qt_internal_add_docs(3DCore
+    doc/qt3d.qdocconf
+)
diff --git a/src/core/core.pro b/src/core/core.pro
index 846e9d836..57421b6fd 100644
--- a/src/core/core.pro
+++ b/src/core/core.pro
@@ -4,6 +4,8 @@ MODULE = 3dcore
 QT = core-private gui-private network
 QT_FOR_PRIVATE = concurrent
 
+QMAKE_DOCS = $$PWD/doc/qt3d.qdocconf
+
 gcov {
     QMAKE_CXXFLAGS += -fprofile-arcs -ftest-coverage
     QMAKE_LFLAGS += -fprofile-arcs -ftest-coverage
@@ -20,3 +22,4 @@ include(services/services.pri)
 include(aspect/aspect.pri)
 
 load(qt_module)
+QMAKE_DOCS_TARGETDIR = qt3d
diff --git a/src/core/doc/Qt3DDoc b/src/core/doc/Qt3DDoc
new file mode 100644
index 000000000..89a66e7e8
--- /dev/null
+++ b/src/core/doc/Qt3DDoc
@@ -0,0 +1,30 @@
+#include <Qt3DCore/Qt3DCore>
+#include <Qt3DLogic/Qt3DLogic>
+#include <Qt3DRender/Qt3DRender>
+#include <Qt3DInput/Qt3DInput>
+#include <Qt3DQuick/Qt3DQuick>
+#include <Qt3DQuickRender/Qt3DQuickRender>
+#include <Qt3DQuickInput/Qt3DQuickInput>
+#include <Qt3DQuickAnimation/Qt3DQuickAnimation>
+#include <Qt3DAnimation/Qt3DAnimation>
+#include <Qt3DQuickExtras/Qt3DQuickExtras>
+#include <Qt3DQuickScene2D/Qt3DQuickScene2D>
+#include <Qt3DExtras/Qt3DExtras>
+
+// Forward declarations for Qt3DInput
+#define Q_3DINPUTSHARED_PRIVATE_EXPORT
+class QAbstractPhysicalDeviceBackendNode;
+
+// partial list of private headers
+#include "../../core/aspects/qaspectmanager_p.h"
+#include "../../core/transforms/matrix4x4_p.h"
+#include "../../core/transforms/vector3d_p.h"
+#include "../../render/raycasting/qray3d_p.h"
+#include "../../render/texture/qtexturegenerator_p.h"
+#include "../../input/frontend/qabstractphysicaldeviceproxy_p.h"
+#include "../../input/frontend/qinputdeviceintegration_p.h"
+#include "../../animation/frontend/qchannelmappingcreatedchange_p.h"
+#include "../../animation/frontend/qclipblendnodecreatedchange_p.h"
+#include "../../animation/backend/clipblendnode_p.h"
+#include "../../quick3d/imports/scene3d/scene3ditem_p.h"
+
diff --git a/src/doc/images/Space-invaders.jpg b/src/core/doc/images/Space-invaders.jpg
index feea250bb..feea250bb 100644
--- a/src/doc/images/Space-invaders.jpg
+++ b/src/core/doc/images/Space-invaders.jpg
diff --git a/src/doc/images/circularbuffer-1.png b/src/core/doc/images/circularbuffer-1.png
index f391dfef7..f391dfef7 100644
--- a/src/doc/images/circularbuffer-1.png
+++ b/src/core/doc/images/circularbuffer-1.png
diff --git a/src/doc/images/circularbuffer-2.png b/src/core/doc/images/circularbuffer-2.png
index 865cc1efb..865cc1efb 100644
--- a/src/doc/images/circularbuffer-2.png
+++ b/src/core/doc/images/circularbuffer-2.png
diff --git a/src/doc/images/circularbuffer-3.png b/src/core/doc/images/circularbuffer-3.png
index a0e56727a..a0e56727a 100644
--- a/src/doc/images/circularbuffer-3.png
+++ b/src/core/doc/images/circularbuffer-3.png
diff --git a/src/doc/images/deferred-framegraph.png b/src/core/doc/images/deferred-framegraph.png
index 0020e10e6..0020e10e6 100644
--- a/src/doc/images/deferred-framegraph.png
+++ b/src/core/doc/images/deferred-framegraph.png
diff --git a/src/doc/images/ecs-1.png b/src/core/doc/images/ecs-1.png
index 6ea006f00..6ea006f00 100644
--- a/src/doc/images/ecs-1.png
+++ b/src/core/doc/images/ecs-1.png
diff --git a/src/doc/images/ecs-2.png b/src/core/doc/images/ecs-2.png
index 749195eaa..749195eaa 100644
--- a/src/doc/images/ecs-2.png
+++ b/src/core/doc/images/ecs-2.png
diff --git a/src/doc/images/framegraph-parallel-build.png b/src/core/doc/images/framegraph-parallel-build.png
index 8ae5ed5a6..8ae5ed5a6 100644
--- a/src/doc/images/framegraph-parallel-build.png
+++ b/src/core/doc/images/framegraph-parallel-build.png
diff --git a/src/doc/images/multiviewport-1.png b/src/core/doc/images/multiviewport-1.png
index 69a9ed32e..69a9ed32e 100644
--- a/src/doc/images/multiviewport-1.png
+++ b/src/core/doc/images/multiviewport-1.png
diff --git a/src/doc/images/multiviewport-2.png b/src/core/doc/images/multiviewport-2.png
index 47056cf5c..47056cf5c 100644
--- a/src/doc/images/multiviewport-2.png
+++ b/src/core/doc/images/multiviewport-2.png
diff --git a/src/doc/images/multiviewport.png b/src/core/doc/images/multiviewport.png
index 1ad5f3a5c..1ad5f3a5c 100644
--- a/src/doc/images/multiviewport.png
+++ b/src/core/doc/images/multiviewport.png
diff --git a/src/doc/images/simple-framegraph.png b/src/core/doc/images/simple-framegraph.png
index 7a57ca139..7a57ca139 100644
--- a/src/doc/images/simple-framegraph.png
+++ b/src/core/doc/images/simple-framegraph.png
diff --git a/src/doc/qt3d.qdocconf b/src/core/doc/qt3d.qdocconf
index aa6be3c33..1b0843ebd 100644
--- a/src/doc/qt3d.qdocconf
+++ b/src/core/doc/qt3d.qdocconf
@@ -44,73 +44,61 @@ tagfile                 = qt3d.tags
 depends                 += qtcore qtgui qtqml qtquick qtdoc
 
 headerdirs += . \
-              ../render \
-              ../core \
-              ../logic \
-              ../plugins \
-              ../quick3d/quick3d \
-              ../input \
-              ../extras \
-              ../animation \
-              ../quick3d/quick3dscene2d \
-              ../quick3d/imports/scene3d
+              ../../render \
+              ../../core \
+              ../../logic \
+              ../../plugins \
+              ../../quick3d/quick3d \
+              ../../input \
+              ../../extras \
+              ../../animation \
+              ../../quick3d/quick3dscene2d \
+              ../../quick3d/imports/scene3d
 
 # Exclude private header files from the documentation build
 excludefiles += "*_p.h"
 
 # Add some private headers explicitly to avoid documentation warnings
-headers       = ../core/transforms/matrix4x4_p.h \
-                ../core/transforms/vector3d_p.h \
-                ../render/raycasting/qray3d_p.h \
-                ../input/frontend/qabstractphysicaldeviceproxy_p.h \
-                ../input/frontend/qinputdeviceintegration_p.h \
-                ../quick3d/imports/scene3d/scene3ditem_p.h
+headers       = ../../core/transforms/matrix4x4_p.h \
+                ../../core/transforms/vector3d_p.h \
+                ../../render/raycasting/qray3d_p.h \
+                ../../input/frontend/qabstractphysicaldeviceproxy_p.h \
+                ../../input/frontend/qinputdeviceintegration_p.h \
+                ../../quick3d/imports/scene3d/scene3ditem_p.h
 
 sourcedirs += . \
-              ../render \
-              ../core \
-              ../logic \
-              ../plugins \
-              ../quick3d/quick3d \
-              ../input \
-              ../extras \
-              ../animation \
-              ../quick3d/quick3dscene2d \
-              ../quick3d/imports/scene3d
-
-
-exampledirs += ../../examples/qt3d \
+              ../../render \
+              ../../core \
+              ../../logic \
+              ../../plugins \
+              ../../quick3d/quick3d \
+              ../../input \
+              ../../extras \
+              ../../animation \
+              ../../quick3d/quick3dscene2d \
+              ../../quick3d/imports/scene3d
+
+
+exampledirs += ../../../examples/qt3d \
                snippets
 
 examples.fileextensions       += "*.fraq *.geom *.vert"
 examples.imageextensions      += "*.png"
 
 excludedirs += \
-              ../plugins/renderplugins \
-              ../plugins/sceneparsers
+              ../../plugins/renderplugins \
+              ../../plugins/sceneparsers
 
 macro.TODO = " "
 imagedirs   += images \
-               ../../examples/qt3d/shadow-map-qml/doc/images \
-               ../../examples/qt3d/basicshapes-cpp/doc/images \
-               ../../examples/qt3d/planets-qml/doc/images \
-               ../../examples/qt3d/wireframe/doc/images \
-               ../../examples/qt3d/audio-visualizer-qml/doc/images \
-               ../../examples/qt3d/simplecustommaterial/doc/images \
-               ../../examples/qt3d/scene2d/doc/images \
-               ../../examples/qt3d/advancedcustommaterial/doc/images
-
-Cpp.ignoretokens     += Q_3DINPUTSHARED_EXPORT \
-                        Q_3DCORESHARED_EXPORT \
-                        Q_3DLOGICSHARED_EXPORT \
-                        Q_3DRENDERSHARED_EXPORT \
-                        Q_3DRENDERSHARED_PRIVATE_EXPORT \
-                        Q_3DQUICKSHARED_PRIVATE_EXPORT \
-                        Q_3DEXTRASSHARED_EXPORT \
-                        Q_3DANIMATIONSHARED_EXPORT \
-                        Q_3DQUICKSCENE2DSHARED_EXPORT
-
-Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY
+               ../../../examples/qt3d/shadow-map-qml/doc/images \
+               ../../../examples/qt3d/basicshapes-cpp/doc/images \
+               ../../../examples/qt3d/planets-qml/doc/images \
+               ../../../examples/qt3d/wireframe/doc/images \
+               ../../../examples/qt3d/audio-visualizer-qml/doc/images \
+               ../../../examples/qt3d/simplecustommaterial/doc/images \
+               ../../../examples/qt3d/scene2d/doc/images \
+               ../../../examples/qt3d/advancedcustommaterial/doc/images
 
 manifestmeta.highlighted.names = \
                 "Qt3D/Qt 3D: Advanced custom material QML Example" \
diff --git a/src/doc/snippets/code/src_core_qcircularbuffer.cpp b/src/core/doc/snippets/code/src_core_qcircularbuffer.cpp
index ae373b92f..ae373b92f 100644
--- a/src/doc/snippets/code/src_core_qcircularbuffer.cpp
+++ b/src/core/doc/snippets/code/src_core_qcircularbuffer.cpp
diff --git a/src/doc/snippets/code/src_render_renderstates_qmultisampleantialiasing.qdocinc b/src/core/doc/snippets/code/src_render_renderstates_qmultisampleantialiasing.qdocinc
index 9c530382f..9c530382f 100644
--- a/src/doc/snippets/code/src_render_renderstates_qmultisampleantialiasing.qdocinc
+++ b/src/core/doc/snippets/code/src_render_renderstates_qmultisampleantialiasing.qdocinc
diff --git a/src/doc/src/externalresources.qdoc b/src/core/doc/src/externalresources.qdoc
index 7272f43b1..7272f43b1 100644
--- a/src/doc/src/externalresources.qdoc
+++ b/src/core/doc/src/externalresources.qdoc
diff --git a/src/doc/src/levelofdetailloader.qdoc b/src/core/doc/src/levelofdetailloader.qdoc
index 64fdf2159..64fdf2159 100644
--- a/src/doc/src/levelofdetailloader.qdoc
+++ b/src/core/doc/src/levelofdetailloader.qdoc
diff --git a/src/doc/src/qmlextracontrollers.qdoc b/src/core/doc/src/qmlextracontrollers.qdoc
index f02f4b29f..f02f4b29f 100644
--- a/src/doc/src/qmlextracontrollers.qdoc
+++ b/src/core/doc/src/qmlextracontrollers.qdoc
diff --git a/src/doc/src/qmlextramaterials.qdoc b/src/core/doc/src/qmlextramaterials.qdoc
index 338bada09..338bada09 100644
--- a/src/doc/src/qmlextramaterials.qdoc
+++ b/src/core/doc/src/qmlextramaterials.qdoc
diff --git a/src/doc/src/qt3d-examples.qdoc b/src/core/doc/src/qt3d-examples.qdoc
index 28259fb85..28259fb85 100644
--- a/src/doc/src/qt3d-examples.qdoc
+++ b/src/core/doc/src/qt3d-examples.qdoc
diff --git a/src/doc/src/qt3d-index.qdoc b/src/core/doc/src/qt3d-index.qdoc
index 8a57a2b10..8a57a2b10 100644
--- a/src/doc/src/qt3d-index.qdoc
+++ b/src/core/doc/src/qt3d-index.qdoc
diff --git a/src/doc/src/qt3d-module.qdoc b/src/core/doc/src/qt3d-module.qdoc
index e6dcf359e..e6dcf359e 100644
--- a/src/doc/src/qt3d-module.qdoc
+++ b/src/core/doc/src/qt3d-module.qdoc
diff --git a/src/doc/src/qt3d-overview.qdoc b/src/core/doc/src/qt3d-overview.qdoc
index 23ed83dcd..23ed83dcd 100644
--- a/src/doc/src/qt3d-overview.qdoc
+++ b/src/core/doc/src/qt3d-overview.qdoc
diff --git a/src/doc/src/qt3danimation-module.qdoc b/src/core/doc/src/qt3danimation-module.qdoc
index 5186afa8b..5186afa8b 100644
--- a/src/doc/src/qt3danimation-module.qdoc
+++ b/src/core/doc/src/qt3danimation-module.qdoc
diff --git a/src/doc/src/qt3dextras-module.qdoc b/src/core/doc/src/qt3dextras-module.qdoc
index 2c6223be9..2c6223be9 100644
--- a/src/doc/src/qt3dextras-module.qdoc
+++ b/src/core/doc/src/qt3dextras-module.qdoc
diff --git a/src/doc/src/qt3dinput-module.qdoc b/src/core/doc/src/qt3dinput-module.qdoc
index 65b309247..65b309247 100644
--- a/src/doc/src/qt3dinput-module.qdoc
+++ b/src/core/doc/src/qt3dinput-module.qdoc
diff --git a/src/doc/src/qt3dlogic-module.qdoc b/src/core/doc/src/qt3dlogic-module.qdoc
index ccbab3253..ccbab3253 100644
--- a/src/doc/src/qt3dlogic-module.qdoc
+++ b/src/core/doc/src/qt3dlogic-module.qdoc
diff --git a/src/doc/src/qt3drender-framegraph.qdoc b/src/core/doc/src/qt3drender-framegraph.qdoc
index 2224a1c8d..2224a1c8d 100644
--- a/src/doc/src/qt3drender-framegraph.qdoc
+++ b/src/core/doc/src/qt3drender-framegraph.qdoc
diff --git a/src/doc/src/qt3drender-geometry.qdoc b/src/core/doc/src/qt3drender-geometry.qdoc
index 478400469..478400469 100644
--- a/src/doc/src/qt3drender-geometry.qdoc
+++ b/src/core/doc/src/qt3drender-geometry.qdoc
diff --git a/src/doc/src/qt3drender-module.qdoc b/src/core/doc/src/qt3drender-module.qdoc
index b11ba3dad..b11ba3dad 100644
--- a/src/doc/src/qt3drender-module.qdoc
+++ b/src/core/doc/src/qt3drender-module.qdoc
diff --git a/src/doc/src/qt3drender-protips.qdoc b/src/core/doc/src/qt3drender-protips.qdoc
index 8aefcd843..8aefcd843 100644
--- a/src/doc/src/qt3drender-protips.qdoc
+++ b/src/core/doc/src/qt3drender-protips.qdoc
diff --git a/src/doc/src/qt3dscene2d-module.qdoc b/src/core/doc/src/qt3dscene2d-module.qdoc
index 94467cf67..94467cf67 100644
--- a/src/doc/src/qt3dscene2d-module.qdoc
+++ b/src/core/doc/src/qt3dscene2d-module.qdoc
diff --git a/src/doc/src/qt3dscene3d-module.qdoc b/src/core/doc/src/qt3dscene3d-module.qdoc
index 27bdd81aa..27bdd81aa 100644
--- a/src/doc/src/qt3dscene3d-module.qdoc
+++ b/src/core/doc/src/qt3dscene3d-module.qdoc
diff --git a/src/doc/src/qt6-changes.qdoc b/src/core/doc/src/qt6-changes.qdoc
index 904a510e4..904a510e4 100644
--- a/src/doc/src/qt6-changes.qdoc
+++ b/src/core/doc/src/qt6-changes.qdoc
diff --git a/src/doc/CMakeLists.txt b/src/doc/CMakeLists.txt
deleted file mode 100644
index 21a0ea140..000000000
--- a/src/doc/CMakeLists.txt
+++ /dev/null
@@ -1,2 +0,0 @@
-# Generated from doc.pro.
-
diff --git a/src/doc/Qt3DDoc b/src/doc/Qt3DDoc
deleted file mode 100644
index d2292cab4..000000000
--- a/src/doc/Qt3DDoc
+++ /dev/null
@@ -1,25 +0,0 @@
-#include <Qt3DCore/Qt3DCore>
-#include <Qt3DLogic/Qt3DLogic>
-#include <Qt3DRender/Qt3DRender>
-#include <Qt3DInput/Qt3DInput>
-#include <Qt3DQuick/Qt3DQuick>
-#include <Qt3DQuickRender/Qt3DQuickRender>
-#include <Qt3DQuickInput/Qt3DQuickInput>
-#include <Qt3DQuickAnimation/Qt3DQuickAnimation>
-#include <Qt3DAnimation/Qt3DAnimation>
-#include <Qt3DQuickExtras/Qt3DQuickExtras>
-#include <Qt3DQuickScene2D/Qt3DQuickScene2D>
-#include <Qt3DExtras/Qt3DExtras>
-
-// partial list of private headers
-#include "../core/aspects/qaspectmanager_p.h"
-#include "../core/transforms/matrix4x4_p.h"
-#include "../core/transforms/vector3d_p.h"
-#include "../render/raycasting/qray3d_p.h"
-#include "../render/texture/qtexturegenerator_p.h"
-#include "../input/frontend/qabstractphysicaldeviceproxy_p.h"
-#include "../input/frontend/qinputdeviceintegration_p.h"
-#include "../animation/frontend/qchannelmappingcreatedchange_p.h"
-#include "../animation/frontend/qclipblendnodecreatedchange_p.h"
-#include "../animation/backend/clipblendnode_p.h"
-#include "../quick3d/imports/scene3d/scene3ditem_p.h"
diff --git a/src/doc/doc.pro b/src/doc/doc.pro
deleted file mode 100644
index ab6d8e9a6..000000000
--- a/src/doc/doc.pro
+++ /dev/null
@@ -1,15 +0,0 @@
-TEMPLATE = aux
-
-CONFIG += force_qt
-
-# Add Qt 3D modules for which QDoc needs include paths passed
-QT += \
-    core-private \
-    3dcore-private \
-    3drender-private \
-    3dinput-private \
-    3danimation-private
-
-QMAKE_DOCS = $$PWD/qt3d.qdocconf
-
-OTHER_FILES += $$PWD/src/*.qdoc
diff --git a/src/input/frontend/qabstractphysicaldeviceproxy_p.h b/src/input/frontend/qabstractphysicaldeviceproxy_p.h
index 512679191..f41e22312 100644
--- a/src/input/frontend/qabstractphysicaldeviceproxy_p.h
+++ b/src/input/frontend/qabstractphysicaldeviceproxy_p.h
@@ -53,7 +53,9 @@
 
 #include <Qt3DInput/qabstractphysicaldevice.h>
 
+#ifndef Q_QDOC
 #include <Qt3DInput/private/qt3dinput_global_p.h>
+#endif
 
 QT_BEGIN_NAMESPACE
 
diff --git a/src/input/frontend/qinputdeviceintegration_p.h b/src/input/frontend/qinputdeviceintegration_p.h
index 9a5618b04..b57c8f6e7 100644
--- a/src/input/frontend/qinputdeviceintegration_p.h
+++ b/src/input/frontend/qinputdeviceintegration_p.h
@@ -56,7 +56,9 @@
 #include <Qt3DCore/qnodeid.h>
 #include <QtCore/QObject>
 
+#ifndef Q_QDOC
 #include <Qt3DInput/private/qabstractphysicaldevicebackendnode_p.h>
+#endif
 
 QT_BEGIN_NAMESPACE
 
diff --git a/src/src.pro b/src/src.pro
index 0a16af003..c807f23e3 100644
--- a/src/src.pro
+++ b/src/src.pro
@@ -26,10 +26,6 @@ src_extras.subdir = $$PWD/extras
 src_extras.target = src_extras
 src_extras.depends = src_render src_input src_logic
 
-src_doc.subdir = $$PWD/doc
-src_doc.target = sub-doc
-src_doc.depends = src_animation src_input
-
 qtHaveModule(quick) {
     # Quick3D libs
     src_quick3d_core.subdir = $$PWD/quick3d/quick3d
@@ -124,10 +120,8 @@ qtConfig(qt3d-render) {
         src_render \
         src_plugins_renderers
 }
-qtConfig(qt3d-animation) {
-    SUBDIRS += src_animation
-    qtConfig(qt3d-input): SUBDIRS += src_doc
-}
+qtConfig(qt3d-animation): SUBDIRS += src_animation
+
 qtConfig(qt3d-extras) {
     SUBDIRS += \
         src_extras \