summaryrefslogtreecommitdiffstats
path: root/src/animation
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@qt.io>2017-06-13 15:06:53 +0200
committerNico Vertriest <nico.vertriest@qt.io>2017-06-19 11:59:02 +0000
commit87dd9e38902a8625c19113a9827a30eadffdb032 (patch)
treee4b9eef1b78bd033649ab7b8bfeef7285daa0355 /src/animation
parent67216fee992710e9a9a3731811a852a9a31ed7ab (diff)
Doc: correct \property and \qmlproperty statements
functionrangefinder.cpp:54: warning: Invalid syntax in '\fn' qabstractclipanimator.cpp:127: warning: Unrecognizable QML module/component qualifier for bool running qabstractclipanimator.cpp:168: warning: Unrecognizable QML module/component qualifier for int loops qadditiveclipblend.cpp:173: warning: Unrecognizable QML module/component qualifier for AbstractClipBlendNode baseClip qadditiveclipblend.cpp:191: warning: Unrecognizable QML module/component qualifier for AbstractClipBlendNode additiveClip qabstractclipanimator.h:62: warning: No documentation for Qt3DAnimation::QAbstractClipAnimator::Loops Change-Id: Iab2686f55149a6998eac81ca0aab991b815b12d9 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
Diffstat (limited to 'src/animation')
-rw-r--r--src/animation/backend/functionrangefinder.cpp7
-rw-r--r--src/animation/frontend/qabstractclipanimator.cpp21
-rw-r--r--src/animation/frontend/qadditiveclipblend.cpp10
3 files changed, 16 insertions, 22 deletions
diff --git a/src/animation/backend/functionrangefinder.cpp b/src/animation/backend/functionrangefinder.cpp
index 168b835ad..8c0e30f4a 100644
--- a/src/animation/backend/functionrangefinder.cpp
+++ b/src/animation/backend/functionrangefinder.cpp
@@ -51,11 +51,12 @@ namespace Animation {
interpolate for example.
*/
-/*!
+/*
\internal
- \fn findLowerBound
- Finds the lower bound index of a range that encloses the requested value.
+ int findLowerBound (float x)
+
+ Finds the lower bound index of a range that encloses the requested value \a x.
We use a technique which tries to be better than a simple bisection. Often when
performing interpolations, subsequent points are correlated with earlier calls.
diff --git a/src/animation/frontend/qabstractclipanimator.cpp b/src/animation/frontend/qabstractclipanimator.cpp
index c75b92d47..9484aea44 100644
--- a/src/animation/frontend/qabstractclipanimator.cpp
+++ b/src/animation/frontend/qabstractclipanimator.cpp
@@ -119,15 +119,14 @@ QAbstractClipAnimator::~QAbstractClipAnimator()
}
/*!
- \qmlproperty bool running
+ \qmlproperty bool QAbstractClipAnimator::running
This property holds whether the animation is currently running.
*/
/*!
- \property running
-
- This property holds whether the animation is currently running.
+ \property QAbstractClipAnimator::isRunning
+ Returns a boolean indicating whether the animation is currently running.
*/
bool QAbstractClipAnimator::isRunning() const
{
@@ -136,18 +135,12 @@ bool QAbstractClipAnimator::isRunning() const
}
/*!
- \property ChannelMapper channelMapper
+ \property ChannelMapper QAbstractClipAnimator::channelMapper
This property holds the ChannelMapper that controls how the channels in
the animation clip map onto the properties of the target objects.
*/
-/*!
- \property channelMapper
-
- This property holds the QChannelMapper that controls how the channels in
- the animation clip map onto the properties of the target objects.
-*/
QChannelMapper *QAbstractClipAnimator::channelMapper() const
{
Q_D(const QAbstractClipAnimator);
@@ -155,7 +148,7 @@ QChannelMapper *QAbstractClipAnimator::channelMapper() const
}
/*!
- \qmlproperty int loops
+ \qmlproperty int QAbstractClipAnimator::loops
This property holds the number of times the animation should play.
@@ -166,11 +159,11 @@ QChannelMapper *QAbstractClipAnimator::channelMapper() const
*/
/*!
- \property loops
+ \property int QAbstractClipAnimator::loopCount
This property holds the number of times the animation should play.
- By default, loops is 1: the animation will play through once and then stop.
+ The value is 1 by default: the animation will play through once and then stop.
If set to QAbstractClipAnimator::Infinite, the animation will continuously
repeat until it is explicitly stopped.
diff --git a/src/animation/frontend/qadditiveclipblend.cpp b/src/animation/frontend/qadditiveclipblend.cpp
index 58ef5e577..5cbd75af6 100644
--- a/src/animation/frontend/qadditiveclipblend.cpp
+++ b/src/animation/frontend/qadditiveclipblend.cpp
@@ -167,14 +167,14 @@ float QAdditiveClipBlend::additiveFactor() const
/*!
\qmlproperty AbstractClipBlendNode baseClip
- This property holds the base animation clip. When the additiveFacgtor is zero the baseClip will
+ This property holds the base animation clip. When the additiveFactor is zero the \a baseClip will
also be the resulting clip of this blend node.
*/
/*!
- \property baseClip
+ \property QAdditiveClipBlend::baseClip
- This property holds the base animation clip. When the additiveFacgtor is zero the baseClip will
- also be the resulting clip of this blend node.
+ This property holds the base animation clip. When the additiveFactor
+ is zero the baseClip will also be the resulting clip of this blend node.
*/
QAbstractClipBlendNode *QAdditiveClipBlend::baseClip() const
{
@@ -189,7 +189,7 @@ QAbstractClipBlendNode *QAdditiveClipBlend::baseClip() const
is controlled by the additiveFactor property.
*/
/*!
- \property additiveClip
+ \property QAdditiveClipBlend::additiveClip
This property holds the additive clip to be blended with the baseClip. The amount of blending
is controlled by the additiveFactor property.