summaryrefslogtreecommitdiffstats
path: root/src/doc/Qt3DDoc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2018-04-20 10:26:56 +0200
committerTopi Reiniƶ <topi.reinio@qt.io>2018-04-20 10:17:18 +0000
commitdcda92d3094f35c50c3665059df1b237bf4904b8 (patch)
tree67d674255dc29cc237f49f6b0d1940679e71d077 /src/doc/Qt3DDoc
parentbb09fa7b64b288a68edc61c52ea8467f96eb3924 (diff)
Doc: Fix documentation warnings related to Clang QDoc parser
Since Qt 5.11, QDoc uses Clang to parse C++ documentation. Clang requires a module header, as well as proper include paths, to build a precompiled header and process the sources. To do this, add a custom module header that pulls in all Qt 3D modules - this way, we can continue using a single documentation project to covers all of Qt 3D. Fix all documentation warnings are caused by missing namespaces, QML module/type names and typos, as well as a number of linking problems and other minor issues. After this change, the remaining documentation issues consist of 'No documentation for ...' warnings. Task-number: QTBUG-67790 Change-Id: I38b91163c475a00cc1893e793240470c5409eb57 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/doc/Qt3DDoc')
-rw-r--r--src/doc/Qt3DDoc23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/doc/Qt3DDoc b/src/doc/Qt3DDoc
new file mode 100644
index 000000000..dbdea1700
--- /dev/null
+++ b/src/doc/Qt3DDoc
@@ -0,0 +1,23 @@
+#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 "../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"