From 09ba2f8b9c360ad4d3cf8ebb04fbfc9c1c57cbe7 Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Tue, 27 Oct 2015 12:17:53 +0100 Subject: [PATCH] Doc: Move the doc artifacts outside of the submodule directory MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-by: Topi Reiniö --- src/collision/doc/qt3dcollision.qdocconf | 62 ------------------ src/core/core.pro | 2 - src/doc/doc.pro | 3 + src/{core => }/doc/images/Space-invaders.jpg | Bin .../doc/images/circularbuffer-1.png | Bin .../doc/images/circularbuffer-2.png | Bin .../doc/images/circularbuffer-3.png | Bin .../doc/images/deferred-framegraph.png | Bin src/{core => }/doc/images/ecs-1.png | Bin src/{core => }/doc/images/ecs-2.png | Bin .../doc/images/framegraph-parallel-build.png | Bin .../doc/images/multiviewport-1.png | Bin .../doc/images/multiviewport-2.png | Bin src/{render => }/doc/images/multiviewport.png | Bin .../doc/images/simple-framegraph.png | Bin src/{core => }/doc/qt3d.qdocconf | 43 ++++++------ .../code/src_core_qcircularbuffer.cpp | 0 .../doc/src/externalresources.qdoc | 0 .../src}/qcircularbuffer.qdoc | 0 src/{render => }/doc/src/qt3d-examples.qdoc | 0 src/{core => }/doc/src/qt3d-index.qdoc | 0 src/{core => }/doc/src/qt3d-module.qdoc | 0 src/{core => }/doc/src/qt3d-overview.qdoc | 0 .../doc/src/qt3dcollision-module.qdoc | 0 src/{core => }/doc/src/qt3dinput-module.qdoc | 0 src/{logic => }/doc/src/qt3dlogic-module.qdoc | 0 .../doc/src/qt3drender-framegraph.qdoc | 0 .../doc/src/qt3drender-module.qdoc | 0 src/src.pro | 3 +- 29 files changed, 27 insertions(+), 86 deletions(-) delete mode 100644 src/collision/doc/qt3dcollision.qdocconf create mode 100644 src/doc/doc.pro rename src/{core => }/doc/images/Space-invaders.jpg (100%) rename src/{core => }/doc/images/circularbuffer-1.png (100%) rename src/{core => }/doc/images/circularbuffer-2.png (100%) rename src/{core => }/doc/images/circularbuffer-3.png (100%) rename src/{render => }/doc/images/deferred-framegraph.png (100%) rename src/{core => }/doc/images/ecs-1.png (100%) rename src/{core => }/doc/images/ecs-2.png (100%) rename src/{render => }/doc/images/framegraph-parallel-build.png (100%) rename src/{render => }/doc/images/multiviewport-1.png (100%) rename src/{render => }/doc/images/multiviewport-2.png (100%) rename src/{render => }/doc/images/multiviewport.png (100%) rename src/{render => }/doc/images/simple-framegraph.png (100%) rename src/{core => }/doc/qt3d.qdocconf (71%) rename src/{core/doc/src => doc}/snippets/code/src_core_qcircularbuffer.cpp (100%) rename src/{render => }/doc/src/externalresources.qdoc (100%) rename src/{core/resources => doc/src}/qcircularbuffer.qdoc (100%) rename src/{render => }/doc/src/qt3d-examples.qdoc (100%) rename src/{core => }/doc/src/qt3d-index.qdoc (100%) rename src/{core => }/doc/src/qt3d-module.qdoc (100%) rename src/{core => }/doc/src/qt3d-overview.qdoc (100%) rename src/{collision => }/doc/src/qt3dcollision-module.qdoc (100%) rename src/{core => }/doc/src/qt3dinput-module.qdoc (100%) rename src/{logic => }/doc/src/qt3dlogic-module.qdoc (100%) rename src/{render => }/doc/src/qt3drender-framegraph.qdoc (100%) rename src/{render => }/doc/src/qt3drender-module.qdoc (100%) 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 similarity index 100% rename from src/core/doc/images/Space-invaders.jpg rename to src/doc/images/Space-invaders.jpg diff --git a/src/core/doc/images/circularbuffer-1.png b/src/doc/images/circularbuffer-1.png similarity index 100% rename from src/core/doc/images/circularbuffer-1.png rename to src/doc/images/circularbuffer-1.png diff --git a/src/core/doc/images/circularbuffer-2.png b/src/doc/images/circularbuffer-2.png similarity index 100% rename from src/core/doc/images/circularbuffer-2.png rename to src/doc/images/circularbuffer-2.png diff --git a/src/core/doc/images/circularbuffer-3.png b/src/doc/images/circularbuffer-3.png similarity index 100% rename from src/core/doc/images/circularbuffer-3.png rename to src/doc/images/circularbuffer-3.png diff --git a/src/render/doc/images/deferred-framegraph.png b/src/doc/images/deferred-framegraph.png similarity index 100% rename from src/render/doc/images/deferred-framegraph.png rename to src/doc/images/deferred-framegraph.png diff --git a/src/core/doc/images/ecs-1.png b/src/doc/images/ecs-1.png similarity index 100% rename from src/core/doc/images/ecs-1.png rename to src/doc/images/ecs-1.png diff --git a/src/core/doc/images/ecs-2.png b/src/doc/images/ecs-2.png similarity index 100% rename from src/core/doc/images/ecs-2.png rename to 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 similarity index 100% rename from src/render/doc/images/framegraph-parallel-build.png rename to src/doc/images/framegraph-parallel-build.png diff --git a/src/render/doc/images/multiviewport-1.png b/src/doc/images/multiviewport-1.png similarity index 100% rename from src/render/doc/images/multiviewport-1.png rename to src/doc/images/multiviewport-1.png diff --git a/src/render/doc/images/multiviewport-2.png b/src/doc/images/multiviewport-2.png similarity index 100% rename from src/render/doc/images/multiviewport-2.png rename to src/doc/images/multiviewport-2.png diff --git a/src/render/doc/images/multiviewport.png b/src/doc/images/multiviewport.png similarity index 100% rename from src/render/doc/images/multiviewport.png rename to src/doc/images/multiviewport.png diff --git a/src/render/doc/images/simple-framegraph.png b/src/doc/images/simple-framegraph.png similarity index 100% rename from src/render/doc/images/simple-framegraph.png rename to src/doc/images/simple-framegraph.png diff --git a/src/core/doc/qt3d.qdocconf b/src/doc/qt3d.qdocconf similarity index 71% rename from src/core/doc/qt3d.qdocconf rename to 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 +headerdirs += . \ + ../render \ + ../core \ + ../collision \ + ../logic \ + ../plugins \ + ../quick3d/quick3d \ + ../input -sourcedirs += .. \ - ../../render \ - ../../collision \ - ../../logic \ - ../../plugins \ - ../../quick3d/quick3d \ - ../../input +sourcedirs += . \ + ../render \ + ../core \ + ../collision \ + ../logic \ + ../plugins \ + ../quick3d/quick3d \ + ../input -exampledirs += ../../../examples/qt3d \ - src/snippets +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 similarity index 100% rename from src/core/doc/src/snippets/code/src_core_qcircularbuffer.cpp rename to src/doc/snippets/code/src_core_qcircularbuffer.cpp diff --git a/src/render/doc/src/externalresources.qdoc b/src/doc/src/externalresources.qdoc similarity index 100% rename from src/render/doc/src/externalresources.qdoc rename to src/doc/src/externalresources.qdoc diff --git a/src/core/resources/qcircularbuffer.qdoc b/src/doc/src/qcircularbuffer.qdoc similarity index 100% rename from src/core/resources/qcircularbuffer.qdoc rename to src/doc/src/qcircularbuffer.qdoc diff --git a/src/render/doc/src/qt3d-examples.qdoc b/src/doc/src/qt3d-examples.qdoc similarity index 100% rename from src/render/doc/src/qt3d-examples.qdoc rename to src/doc/src/qt3d-examples.qdoc diff --git a/src/core/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc similarity index 100% rename from src/core/doc/src/qt3d-index.qdoc rename to src/doc/src/qt3d-index.qdoc diff --git a/src/core/doc/src/qt3d-module.qdoc b/src/doc/src/qt3d-module.qdoc similarity index 100% rename from src/core/doc/src/qt3d-module.qdoc rename to src/doc/src/qt3d-module.qdoc diff --git a/src/core/doc/src/qt3d-overview.qdoc b/src/doc/src/qt3d-overview.qdoc similarity index 100% rename from src/core/doc/src/qt3d-overview.qdoc rename to src/doc/src/qt3d-overview.qdoc diff --git a/src/collision/doc/src/qt3dcollision-module.qdoc b/src/doc/src/qt3dcollision-module.qdoc similarity index 100% rename from src/collision/doc/src/qt3dcollision-module.qdoc rename to src/doc/src/qt3dcollision-module.qdoc diff --git a/src/core/doc/src/qt3dinput-module.qdoc b/src/doc/src/qt3dinput-module.qdoc similarity index 100% rename from src/core/doc/src/qt3dinput-module.qdoc rename to src/doc/src/qt3dinput-module.qdoc diff --git a/src/logic/doc/src/qt3dlogic-module.qdoc b/src/doc/src/qt3dlogic-module.qdoc similarity index 100% rename from src/logic/doc/src/qt3dlogic-module.qdoc rename to src/doc/src/qt3dlogic-module.qdoc diff --git a/src/render/doc/src/qt3drender-framegraph.qdoc b/src/doc/src/qt3drender-framegraph.qdoc similarity index 100% rename from src/render/doc/src/qt3drender-framegraph.qdoc rename to src/doc/src/qt3drender-framegraph.qdoc diff --git a/src/render/doc/src/qt3drender-module.qdoc b/src/doc/src/qt3drender-module.qdoc similarity index 100% rename from src/render/doc/src/qt3drender-module.qdoc rename to 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