Doc: Move the doc artifacts outside of the submodule directory

The qdocconf now lives in 'src/doc' because the documentation
project defined by it covers the whole Qt 3D module. This change
enables qmake to use 'qt3d' as the output directory for doc make
targets. The new 'doc' directory also includes the relevant images,
snippets, and the qdoc files.

Change-Id: Ibc6d0912f8b1e665767e97630b3e5509e10c5710
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>

29 files changed, 30 insertions, 89 deletions

diff --git a/src/collision/doc/qt3dcollision.qdocconf b/src/collision/doc/qt3dcollision.qdocconf
deleted file mode 100644
index 294eabf48..000000000
--- a/src/collision/doc/qt3dcollision.qdocconf
+++ /dev/null
@@ -1,62 +0,0 @@
-include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
-
-project                 = Qt3DCollision
-description             = Qt3D Collision Reference Documentation
-version                 = $QT_VERSION
-
-examplesinstallpath     = qt3d
-
-qhp.projects            = Qt3DCollision
-
-qhp.Qt3DCollision.file                = qt3dcollision.qhp
-qhp.Qt3DCollision.namespace           = org.qt-project.qt3dcollision.$QT_VERSION_TAG
-qhp.Qt3DCollision.virtualFolder       = qt3dcollision
-qhp.Qt3DCollision.indexTitle          = Qt3D Module
-qhp.Qt3DCollision.indexRoot           =
-
-qhp.Qt3DCollision.filterAttributes                   = qt3dcollision $QT_VERSION qtrefdoc
-qhp.Qt3DCollision.customFilters.Qt.name              = Qt3DCollision $QT_VERSION
-qhp.Qt3DCollision.customFilters.Qt.filterAttributes  = qt3dcollision $QT_VERSION
-
-qhp.Qt3DCollision.subprojects                    = classes qmltypes
-
-qhp.Qt3DCollision.subprojects.classes.title      = C++ Classes
-qhp.Qt3DCollision.subprojects.classes.indexTitle = Qt3D Collision C++ Classes
-qhp.Qt3DCollision.subprojects.classes.selectors  = class fake:headerfile
-qhp.Qt3DCollision.subprojects.classes.sortPages  = true
-
-qhp.Qt3DCollision.subprojects.qmltypes.title      = QML Types
-qhp.Qt3DCollision.subprojects.qmltypes.indexTitle = Qt3D Collision QML Types
-qhp.Qt3DCollision.subprojects.qmltypes.selectors  = qmlclass
-qhp.Qt3DCollision.subprojects.qmltypes.sortPages  = true
-
-tagfile                 = ../../../doc/qt3dcollision/qt3dcollision.tags
-
-depends                 += qtcore qtqml qtquick qtdoc qt3drenderer
-
-headerdirs += .. \
-              ../../plugins \
-              ../../quick3d/quick3d \
-              ../../input
-
-sourcedirs += .. \
-              ../../plugins \
-              ../../quick3d/quick3d \
-              ../../input
-
-exampledirs += src/snippets
-
-#excludedirs +=
-
-imagedirs   += images \
-               ../../../examples/qt3d/shadow-map-qml/doc/images
-
-Cpp.ignoretokens     += QT3DCOLLISION_PRIVATE_EXPORT \
-                        QT3DINPUTSHARED_EXPORT \
-                        QT3DCOLLISIONSHARED_EXPORT
-
-Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY
-
-navigation.landingpage = "Qt3D Module"
-navigation.cppclassespage = "Qt3D Collision C++ Classes"
-navigation.qmltypespage = "Qt3D Collision QML Types"
diff --git a/src/core/core.pro b/src/core/core.pro
index 9bf95f3bd..07579bbed 100644
--- a/src/core/core.pro
+++ b/src/core/core.pro
@@ -11,8 +11,6 @@ DEFINES += QT3DCORE_LIBRARY
 #    DEFINES += THREAD_WEAVER
 #}
 
-QMAKE_DOCS = $$PWD/doc/qt3d.qdocconf
-
 gcov {
     CONFIG += static
     QMAKE_CXXFLAGS += -fprofile-arcs -ftest-coverage
diff --git a/src/doc/doc.pro b/src/doc/doc.pro
new file mode 100644
index 000000000..a0ef6f976
--- /dev/null
+++ b/src/doc/doc.pro
@@ -0,0 +1,3 @@
+TEMPLATE = aux
+
+QMAKE_DOCS = $$PWD/qt3d.qdocconf
diff --git a/src/core/doc/images/Space-invaders.jpg b/src/doc/images/Space-invaders.jpg
index feea250bb..feea250bb 100644
--- a/src/core/doc/images/Space-invaders.jpg
+++ b/src/doc/images/Space-invaders.jpg
diff --git a/src/core/doc/images/circularbuffer-1.png b/src/doc/images/circularbuffer-1.png
index f391dfef7..f391dfef7 100644
--- a/src/core/doc/images/circularbuffer-1.png
+++ b/src/doc/images/circularbuffer-1.png
diff --git a/src/core/doc/images/circularbuffer-2.png b/src/doc/images/circularbuffer-2.png
index 865cc1efb..865cc1efb 100644
--- a/src/core/doc/images/circularbuffer-2.png
+++ b/src/doc/images/circularbuffer-2.png
diff --git a/src/core/doc/images/circularbuffer-3.png b/src/doc/images/circularbuffer-3.png
index a0e56727a..a0e56727a 100644
--- a/src/core/doc/images/circularbuffer-3.png
+++ b/src/doc/images/circularbuffer-3.png
diff --git a/src/render/doc/images/deferred-framegraph.png b/src/doc/images/deferred-framegraph.png
index 913539d50..913539d50 100644
--- a/src/render/doc/images/deferred-framegraph.png
+++ b/src/doc/images/deferred-framegraph.png
diff --git a/src/core/doc/images/ecs-1.png b/src/doc/images/ecs-1.png
index 6ea006f00..6ea006f00 100644
--- a/src/core/doc/images/ecs-1.png
+++ b/src/doc/images/ecs-1.png
diff --git a/src/core/doc/images/ecs-2.png b/src/doc/images/ecs-2.png
index 749195eaa..749195eaa 100644
--- a/src/core/doc/images/ecs-2.png
+++ b/src/doc/images/ecs-2.png
diff --git a/src/render/doc/images/framegraph-parallel-build.png b/src/doc/images/framegraph-parallel-build.png
index fe3fdd176..fe3fdd176 100644
--- a/src/render/doc/images/framegraph-parallel-build.png
+++ b/src/doc/images/framegraph-parallel-build.png
diff --git a/src/render/doc/images/multiviewport-1.png b/src/doc/images/multiviewport-1.png
index 27b9c04d5..27b9c04d5 100644
--- a/src/render/doc/images/multiviewport-1.png
+++ b/src/doc/images/multiviewport-1.png
diff --git a/src/render/doc/images/multiviewport-2.png b/src/doc/images/multiviewport-2.png
index 397cde96f..397cde96f 100644
--- a/src/render/doc/images/multiviewport-2.png
+++ b/src/doc/images/multiviewport-2.png
diff --git a/src/render/doc/images/multiviewport.png b/src/doc/images/multiviewport.png
index 1ad5f3a5c..1ad5f3a5c 100644
--- a/src/render/doc/images/multiviewport.png
+++ b/src/doc/images/multiviewport.png
diff --git a/src/render/doc/images/simple-framegraph.png b/src/doc/images/simple-framegraph.png
index 334e995f0..334e995f0 100644
--- a/src/render/doc/images/simple-framegraph.png
+++ b/src/doc/images/simple-framegraph.png
diff --git a/src/core/doc/qt3d.qdocconf b/src/doc/qt3d.qdocconf
index d58373c27..1a63a8bd5 100644
--- a/src/core/doc/qt3d.qdocconf
+++ b/src/doc/qt3d.qdocconf
@@ -34,25 +34,27 @@ tagfile                 = qt3d.tags
 
 depends                 += qtcore qtqml qtquick qtdoc
 
-headerdirs += .. \
-              ../../render \
-              ../../collision \
-              ../../logic \
-              ../../plugins \
-              ../../quick3d/quick3d \
-              ../../input
-
-
-sourcedirs += .. \
-              ../../render \
-              ../../collision \
-              ../../logic \
-              ../../plugins \
-              ../../quick3d/quick3d \
-              ../../input
-
-exampledirs += ../../../examples/qt3d \
-               src/snippets
+headerdirs += . \
+              ../render \
+              ../core \
+              ../collision \
+              ../logic \
+              ../plugins \
+              ../quick3d/quick3d \
+              ../input
+
+
+sourcedirs += . \
+              ../render \
+              ../core \
+              ../collision \
+              ../logic \
+              ../plugins \
+              ../quick3d/quick3d \
+              ../input
+
+exampledirs += ../../examples/qt3d \
+               snippets
 
 examplesinstallpath = qt3d
 
@@ -62,11 +64,10 @@ examples.imageextensions      += "*.png"
 #excludedirs +=
 
 imagedirs   += images \
-               ../../render/doc/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/shadow-map-qml/doc/images \
+               ../../examples/qt3d/basicshapes-cpp/doc/images \
+               ../../examples/qt3d/planets-qml/doc/images \
+               ../../examples/qt3d/wireframe/doc/images
 
 Cpp.ignoretokens     += QT3DCORE_PRIVATE_EXPORT \
                         QT3DINPUTSHARED_EXPORT \
diff --git a/src/core/doc/src/snippets/code/src_core_qcircularbuffer.cpp b/src/doc/snippets/code/src_core_qcircularbuffer.cpp
index 574ca75c8..574ca75c8 100644
--- a/src/core/doc/src/snippets/code/src_core_qcircularbuffer.cpp
+++ b/src/doc/snippets/code/src_core_qcircularbuffer.cpp
diff --git a/src/render/doc/src/externalresources.qdoc b/src/doc/src/externalresources.qdoc
index 8ddce9d47..8ddce9d47 100644
--- a/src/render/doc/src/externalresources.qdoc
+++ b/src/doc/src/externalresources.qdoc
diff --git a/src/core/resources/qcircularbuffer.qdoc b/src/doc/src/qcircularbuffer.qdoc
index 080eeab98..080eeab98 100644
--- a/src/core/resources/qcircularbuffer.qdoc
+++ b/src/doc/src/qcircularbuffer.qdoc
diff --git a/src/render/doc/src/qt3d-examples.qdoc b/src/doc/src/qt3d-examples.qdoc
index 4ba413e50..4ba413e50 100644
--- a/src/render/doc/src/qt3d-examples.qdoc
+++ b/src/doc/src/qt3d-examples.qdoc
diff --git a/src/core/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc
index db8785436..db8785436 100644
--- a/src/core/doc/src/qt3d-index.qdoc
+++ b/src/doc/src/qt3d-index.qdoc
diff --git a/src/core/doc/src/qt3d-module.qdoc b/src/doc/src/qt3d-module.qdoc
index bc9042b46..bc9042b46 100644
--- a/src/core/doc/src/qt3d-module.qdoc
+++ b/src/doc/src/qt3d-module.qdoc
diff --git a/src/core/doc/src/qt3d-overview.qdoc b/src/doc/src/qt3d-overview.qdoc
index 133f6fd14..133f6fd14 100644
--- a/src/core/doc/src/qt3d-overview.qdoc
+++ b/src/doc/src/qt3d-overview.qdoc
diff --git a/src/collision/doc/src/qt3dcollision-module.qdoc b/src/doc/src/qt3dcollision-module.qdoc
index 6c7151128..6c7151128 100644
--- a/src/collision/doc/src/qt3dcollision-module.qdoc
+++ b/src/doc/src/qt3dcollision-module.qdoc
diff --git a/src/core/doc/src/qt3dinput-module.qdoc b/src/doc/src/qt3dinput-module.qdoc
index c46d577dd..c46d577dd 100644
--- a/src/core/doc/src/qt3dinput-module.qdoc
+++ b/src/doc/src/qt3dinput-module.qdoc
diff --git a/src/logic/doc/src/qt3dlogic-module.qdoc b/src/doc/src/qt3dlogic-module.qdoc
index f43eb44e2..f43eb44e2 100644
--- a/src/logic/doc/src/qt3dlogic-module.qdoc
+++ b/src/doc/src/qt3dlogic-module.qdoc
diff --git a/src/render/doc/src/qt3drender-framegraph.qdoc b/src/doc/src/qt3drender-framegraph.qdoc
index 52a4e2227..52a4e2227 100644
--- a/src/render/doc/src/qt3drender-framegraph.qdoc
+++ b/src/doc/src/qt3drender-framegraph.qdoc
diff --git a/src/render/doc/src/qt3drender-module.qdoc b/src/doc/src/qt3drender-module.qdoc
index aa4dac44f..aa4dac44f 100644
--- a/src/render/doc/src/qt3drender-module.qdoc
+++ b/src/doc/src/qt3drender-module.qdoc
diff --git a/src/src.pro b/src/src.pro
index 849c25d82..55bf6c13b 100644
--- a/src/src.pro
+++ b/src/src.pro
@@ -73,6 +73,7 @@ SUBDIRS += \
     src_quick3d_imports_input \
     src_quick3d_imports_logic \
     src_quick3d_imports_collision \
-    src_plugins_sceneparsers
+    src_plugins_sceneparsers \
+    doc