diff options
author | Topi Reinio <topi.reinio@qt.io> | 2018-04-20 10:26:56 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@qt.io> | 2018-04-20 10:17:18 +0000 |
commit | dcda92d3094f35c50c3665059df1b237bf4904b8 (patch) | |
tree | 67d674255dc29cc237f49f6b0d1940679e71d077 /src/render/frontend/qpickingsettings.cpp | |
parent | bb09fa7b64b288a68edc61c52ea8467f96eb3924 (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/render/frontend/qpickingsettings.cpp')
-rw-r--r-- | src/render/frontend/qpickingsettings.cpp | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/render/frontend/qpickingsettings.cpp b/src/render/frontend/qpickingsettings.cpp index 5a49cd182..66d3fc912 100644 --- a/src/render/frontend/qpickingsettings.cpp +++ b/src/render/frontend/qpickingsettings.cpp @@ -61,7 +61,7 @@ namespace Qt3DRender { In both cases, a ray will be cast through the scene to find geometry intersecting the ray. - \sa QObjectPicker, QPickEvent, QPickTriangleEvent, QRayCaster, QScreenRayCaster. + \sa QObjectPicker, QPickEvent, QPickTriangleEvent, QRayCaster, QScreenRayCaster */ /*! @@ -151,7 +151,7 @@ float QPickingSettings::worldSpaceTolerance() const * any edge of the entity's mesh component. * \value PointPicking An entity is considered picked if the picking ray intersects with * any point of the entity's mesh component. - * \value PrimitePicking An entity is considered picked if the picking ray intersects with + * \value PrimitivePicking An entity is considered picked if the picking ray intersects with * any point, edge or triangle of the entity's mesh component. */ @@ -285,7 +285,7 @@ void QPickingSettings::setFaceOrientationPickingMode(QPickingSettings::FaceOrien Holds the threshold, in model space coordinates, used to evaluate line and point picking. */ /*! - * Set the threshold used for line and point picking + * Sets the threshold used for line and point picking to \a worldSpaceTolerance. */ void QPickingSettings::setWorldSpaceTolerance(float worldSpaceTolerance) { |