Doc: Fix documentation warnings for Qt 3D Render

This change fixes multiple QDoc warnings for Qt 3D Render that are
related to how Clang parses the source code and the \fn QDoc
commands. A number of changes are related to preventing documentation
for private classes from generating warnings.

We still have a number of 'No documentation for ...' warnings left -
those are not addressed in this change.

Change-Id: Ic92a729496a81e7869060811ed7dd23408cff833
Reviewed-by: Martin Smith <martin.smith@qt.io>

1 files changed, 15 insertions, 14 deletions

diff --git a/src/render/raycasting/qray3d.cpp b/src/render/raycasting/qray3d.cpp
index e26e1e38c..6d8469aa1 100644
--- a/src/render/raycasting/qray3d.cpp
+++ b/src/render/raycasting/qray3d.cpp
@@ -47,7 +47,8 @@ namespace Qt3DRender {
 namespace RayCasting {
 
 /*!
-    \class Qt3DRender::QRay3D
+    \internal
+    \class Qt3DRender::RayCasting::QRay3D
     \inmodule Qt3DRender
     \brief The QRay3D class defines a directional line in 3D space extending through an origin point.
     \since 5.5
@@ -70,7 +71,7 @@ namespace RayCasting {
 */
 
 /*!
-    \fn Qt3DRender::QRay3D::QRay3D()
+    \fn Qt3DRender::RayCasting::QRay3D::QRay3D()
 
     Construct a default ray with an origin() of (0, 0, 0), a
     direction() of (0, 0, 1) and a distance of 1.
@@ -82,7 +83,7 @@ QRay3D::QRay3D()
 }
 
 /*!
-    \fn Qt3DRender::QRay3D::QRay3D(const QVector3D &origin, const QVector3D &direction, float distance)
+    \fn Qt3DRender::RayCasting::QRay3D::QRay3D(const QVector3D &origin, const QVector3D &direction, float distance)
 
     Construct a ray given its defining \a origin, \a direction and \a distance.
     The \a direction does not need to be normalized.
@@ -104,7 +105,7 @@ QRay3D::~QRay3D()
 }
 
 /*!
-    \fn QVector3D Qt3DRender::QRay3D::origin() const
+    \fn QVector3D Qt3DRender::RayCasting::QRay3D::origin() const
 
     Returns the origin of this ray.  The default value is (0, 0, 0).
 
@@ -116,7 +117,7 @@ Vector3D QRay3D::origin() const
 }
 
 /*!
-    \fn void Qt3DRender::QRay3D::setOrigin(const QVector3D &value)
+    \fn void Qt3DRender::RayCasting::QRay3D::setOrigin(const QVector3D &value)
 
     Sets the origin point of this ray to \a value.
 
@@ -128,7 +129,7 @@ void QRay3D::setOrigin(const Vector3D &value)
 }
 
 /*!
-    \fn QVector3D Qt3DRender::QRay3D::direction() const
+    \fn QVector3D Qt3DRender::RayCasting::QRay3D::direction() const
 
     Returns the direction vector of this ray.  The default value is (0, 0, 1).
 
@@ -140,7 +141,7 @@ Vector3D QRay3D::direction() const
 }
 
 /*!
-    \fn void Qt3DRender::QRay3D::setDirection(const QVector3D &direction)
+    \fn void Qt3DRender::RayCasting::QRay3D::setDirection(const QVector3D &direction)
 
     Sets the direction vector of this ray to \a direction.
 
@@ -220,7 +221,7 @@ bool QRay3D::contains(const QRay3D &ray) const
 }
 
 /*!
-    \fn QVector3D Qt3DRender::QRay3D::point(float t) const
+    \fn QVector3D Qt3DRender::RayCasting::QRay3D::point(float t) const
 
     Returns the point on the ray defined by moving \a t units
     along the ray in the direction of the direction() vector.
@@ -284,7 +285,7 @@ float QRay3D::distance(const Vector3D  &point) const
 }
 
 /*!
-    \fn QRay3D &Qt3DRender::QRay3D::transform(const QMatrix4x4 &matrix)
+    \fn Qt3DRender::RayCasting::QRay3D &Qt3DRender::RayCasting::QRay3D::transform(const QMatrix4x4 &matrix)
 
     Transforms this ray using \a matrix, replacing origin() and
     direction() with the transformed versions.
@@ -293,7 +294,7 @@ float QRay3D::distance(const Vector3D  &point) const
 */
 
 /*!
-    \fn QRay3D Qt3DRender::QRay3D::transformed(const QMatrix4x4 &matrix) const
+    \fn Qt3DRender::RayCasting::QRay3D Qt3DRender::RayCasting::QRay3D::transformed(const QMatrix4x4 &matrix) const
 
     Returns a new ray that is formed by transforming origin()
     and direction() using \a matrix.
@@ -302,7 +303,7 @@ float QRay3D::distance(const Vector3D  &point) const
 */
 
 /*!
-    \fn bool Qt3DRender::QRay3D::operator==(const QRay3D &other) const
+    \fn bool Qt3DRender::RayCasting::QRay3D::operator==(const QRay3D &other) const
 
     Returns \c true if this ray is the same as \a other; \c false otherwise.
 
@@ -310,7 +311,7 @@ float QRay3D::distance(const Vector3D  &point) const
 */
 
 /*!
-    \fn bool Qt3DRender::QRay3D::operator!=(const QRay3D &other) const
+    \fn bool Qt3DRender::RayCasting::QRay3D::operator!=(const QRay3D &other) const
 
     Returns \c true if this ray is not the same as \a other; \c false otherwise.
 
@@ -318,8 +319,8 @@ float QRay3D::distance(const Vector3D  &point) const
 */
 
 /*!
-    \fn bool qFuzzyCompare(const Qt3DRender::QRay3D &ray1, const Qt3DRender::QRay3D &ray2)
-    \relates Qt3DRender::QRay3D
+    \fn bool qFuzzyCompare(const Qt3DRender::RayCasting::QRay3D &ray1, const Qt3DRender::RayCasting::QRay3D &ray2)
+    \relates  Qt3DRender::RayCasting::QRay3D
 
     Returns \c true if \a ray1 and \a ray2 are almost equal; \c false
     otherwise.