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>

7 files changed, 15 insertions, 39 deletions

diff --git a/src/animation/backend/bezierevaluator.cpp b/src/animation/backend/bezierevaluator.cpp
index 2752904fc..a56dc7007 100644
--- a/src/animation/backend/bezierevaluator.cpp
+++ b/src/animation/backend/bezierevaluator.cpp
@@ -101,6 +101,8 @@ float BezierEvaluator::valueForTime(float time) const
 }
 
 /*!
+    \internal
+
     Calculates the value of the Bezier parameter, u, for the
     requested time which is the x coordinate of the Keyframes.
 
diff --git a/src/animation/backend/clipblendnode.cpp b/src/animation/backend/clipblendnode.cpp
index 94a956837..81fc61910 100644
--- a/src/animation/backend/clipblendnode.cpp
+++ b/src/animation/backend/clipblendnode.cpp
@@ -93,7 +93,7 @@ ClipResults ClipBlendNode::clipResults(Qt3DCore::QNodeId animatorId) const
     return ClipResults();
 }
 
-/*!
+/*
     \fn QVector<Qt3DCore::QNodeId> ClipBlendNode::currentDependencyIds() const
     \internal
 
@@ -115,7 +115,7 @@ ClipResults ClipBlendNode::clipResults(Qt3DCore::QNodeId animatorId) const
     evaluated in one pass, and the tree in a subsequent pass.
 */
 
-/*!
+/*
     \fn QVector<Qt3DCore::QNodeId> ClipBlendNode::allDependencyIds() const
     \internal
 
@@ -126,7 +126,7 @@ ClipResults ClipBlendNode::clipResults(Qt3DCore::QNodeId animatorId) const
     parameter. Not just those bounding the current blend value.
 */
 
-/*!
+/*
     \internal
 
     Fetches the ClipResults from the nodes listed in the dependencyIds
diff --git a/src/animation/frontend/qabstractclipanimator.cpp b/src/animation/frontend/qabstractclipanimator.cpp
index f531127c7..ba5d9456b 100644
--- a/src/animation/frontend/qabstractclipanimator.cpp
+++ b/src/animation/frontend/qabstractclipanimator.cpp
@@ -218,7 +218,7 @@ QClock *QAbstractClipAnimator::clock() const
 }
 
 /*!
-    \property int QAbstractClipAnimator::normalizedTime
+    \property Qt3DAnimation::QAbstractClipAnimator::normalizedTime
 
     This property holds the clips normalized time.
 */
diff --git a/src/animation/frontend/qchannelmappingcreatedchange.cpp b/src/animation/frontend/qchannelmappingcreatedchange.cpp
index 6da1eb23e..6812278ac 100644
--- a/src/animation/frontend/qchannelmappingcreatedchange.cpp
+++ b/src/animation/frontend/qchannelmappingcreatedchange.cpp
@@ -49,9 +49,9 @@ QChannelMappingCreatedChangeBasePrivate::QChannelMappingCreatedChangeBasePrivate
 }
 
 /*!
-    \class QChannelmappingCreatedChangeBase
+    \class Qt3DAnimation::QChannelMappingCreatedChangeBase
     \inmodule Qt3DCore
-    \brief Base class for handling creation changes for QAbstractSkeleton sub-classes
+    \brief Base class for handling creation changes for QAbstractSkeleton sub-classes.
 */
 QChannelMappingCreatedChangeBase::QChannelMappingCreatedChangeBase(const QAbstractChannelMapping *mapping)
     : Qt3DCore::QNodeCreatedChangeBase(*new QChannelMappingCreatedChangeBasePrivate(mapping), mapping)
diff --git a/src/animation/frontend/qclipblendnodecreatedchange.cpp b/src/animation/frontend/qclipblendnodecreatedchange.cpp
index 0dc417b1c..5192e6a01 100644
--- a/src/animation/frontend/qclipblendnodecreatedchange.cpp
+++ b/src/animation/frontend/qclipblendnodecreatedchange.cpp
@@ -49,7 +49,7 @@ QClipBlendNodeCreatedChangeBasePrivate::QClipBlendNodeCreatedChangeBasePrivate(c
 }
 
 /*!
-   \class QClipBlendNodeCreateChangeBase
+   \class Qt3DAnimation::QClipBlendNodeCreatedChangeBase
    \inherits Qt3DCore::QNodeCreatedChangeBase
    \inmodule Qt3DAnimation
    \brief Base class for changes in QClipBlendNode
@@ -63,9 +63,9 @@ QClipBlendNodeCreatedChangeBase::~QClipBlendNodeCreatedChangeBase()
 {
 }
 /*!
-    typedef Qt3DAnimation::QClipBlendNodeCreatedChangeBasePtr
+    \typedef Qt3DAnimation::QClipBlendNodeCreatedChangeBasePtr
 
-    A shared pointer for QClipBlendNodeCreatedChangeBase
+    A shared pointer for QClipBlendNodeCreatedChangeBase.
 */
 
 } // Qt3DAnimation
diff --git a/src/animation/frontend/qkeyframe.cpp b/src/animation/frontend/qkeyframe.cpp
index 1d63af3ab..2b2dc24bd 100644
--- a/src/animation/frontend/qkeyframe.cpp
+++ b/src/animation/frontend/qkeyframe.cpp
@@ -44,9 +44,9 @@ QT_BEGIN_NAMESPACE
 namespace Qt3DAnimation {
 
 /*!
-    \class QKeyframe
+    \class Qt3DAnimation::QKeyFrame
     \inmodule Qt3DAnimation
-    \brief A base class for handling keyframes
+    \brief A base class for handling keyframes.
 */
 
 } // namespace Qt3DAnimation
diff --git a/src/animation/frontend/qlerpclipblend.cpp b/src/animation/frontend/qlerpclipblend.cpp
index 3b26adbaa..12f4d7aec 100644
--- a/src/animation/frontend/qlerpclipblend.cpp
+++ b/src/animation/frontend/qlerpclipblend.cpp
@@ -69,12 +69,12 @@ namespace Qt3DAnimation {
     \inherits Qt3DAnimation::QAbstractClipBlendNode
 
     \brief Performs a linear interpolation of two animation clips based on a
-    normalized factor
+    normalized factor.
 
     \since 5.9
 
     QLerpClipBlend can be useful to create advanced animation effects based on
-    individual animation clips. For instance, given a player character,, lerp
+    individual animation clips. For instance, given a player character, lerp
     blending could be used to combine a walking animation clip with an injured
     animation clip based on a blend factor that increases the more the player
     gets injured. This would then allow with blend factor == 0 to have a non
@@ -224,32 +224,6 @@ void QLerpClipBlend::setEndClip(Qt3DAnimation::QAbstractClipBlendNode *endClip)
     emit endClipChanged(endClip);
 }
 
-/*!
-    \qmlproperty list<AnimationClip> LerpBlend::clips
-
-    Holds the list of AnimationClip nodes against which the blending is performed.
-
-    \note Only the two first AnimationClip are used, subsequent ones are ignored
-*/
-
-
-/*!
-    \fn void QLerpClipBlend::addClip(QAbstractAnimationClip *clip);
-    Adds a \a clip to the blending node's clips list.
-
-    \note Only the two first AnimationClip are used, subsequent ones are ignored
- */
-
-/*!
-    \fn void QLerpClipBlend::removeClip(QAbstractAnimationClip *clip);
-    Removes a \a clip from the blending node's clips list.
- */
-
-/*!
-    \fn QVector<QAbstractAnimationClip *> QLerpClipBlend::clips() const;
-    Returns the list of QAnimationClip against which the blending is performed.
- */
-
 } // Qt3DAnimation
 
 QT_END_NAMESPACE