summaryrefslogtreecommitdiffstats
path: root/src/extras/geometries
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/extras/geometries
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/extras/geometries')
-rw-r--r--src/extras/geometries/qplanegeometry.cpp3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/extras/geometries/qplanegeometry.cpp b/src/extras/geometries/qplanegeometry.cpp
index 0176accdd..7c77f5028 100644
--- a/src/extras/geometries/qplanegeometry.cpp
+++ b/src/extras/geometries/qplanegeometry.cpp
@@ -284,13 +284,14 @@ public:
* \brief The QPlaneGeometry class allows creation of a plane in 3D space.
* \since 5.7
* \ingroup geometries
- * \inherits Qt3DRender::QGeometry
*
* The QPlaneGeometry class is most commonly used internally by the QPlaneMesh
* but can also be used in custom Qt3DRender::QGeometryRenderer subclasses.
*/
/*!
+ * \fn Qt3DExtras::QPlaneGeometry::QPlaneGeometry(QNode *parent)
+ *
* Constructs a new QPlaneGeometry with \a parent.
*/
QPlaneGeometry::QPlaneGeometry(QPlaneGeometry::QNode *parent)