summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@qt.io>2018-01-19 15:22:22 +0100
committerNico Vertriest <nico.vertriest@qt.io>2018-01-24 09:07:37 +0000
commit09c344d28017e06af6b34bc3c7b781902d052059 (patch)
tree657c5a857bb3c670deb9d3b17ae2497a7acbfe5e
parente2e162b9ca122e68c444b536888f30c6f1c10de4 (diff)
downloadqt3d-09c344d28017e06af6b34bc3c7b781902d052059.tar.gz
Doc: add doc to undocumented methods in qt3d
Change-Id: Icde8db3bb95f0275d820f5e0effa01ac2033134b Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
-rw-r--r--src/animation/frontend/qabstractclipanimator.cpp35
1 files changed, 28 insertions, 7 deletions
diff --git a/src/animation/frontend/qabstractclipanimator.cpp b/src/animation/frontend/qabstractclipanimator.cpp
index 9cdffee92..da3f97379 100644
--- a/src/animation/frontend/qabstractclipanimator.cpp
+++ b/src/animation/frontend/qabstractclipanimator.cpp
@@ -134,13 +134,12 @@ QAbstractClipAnimator::~QAbstractClipAnimator()
}
/*!
- \qmlproperty bool QAbstractClipAnimator::running
+ \property Qt3DAnimation::QAbstractClipAnimator::running
- This property holds whether the animation is currently running.
+ This property holds a boolean indicating whether the animation is currently running.
*/
/*!
- \property QAbstractClipAnimator::isRunning
Returns a boolean indicating whether the animation is currently running.
*/
bool QAbstractClipAnimator::isRunning() const
@@ -150,7 +149,7 @@ bool QAbstractClipAnimator::isRunning() const
}
/*!
- \property ChannelMapper QAbstractClipAnimator::channelMapper
+ \property Qt3DAnimation::QAbstractClipAnimator::channelMapper
This property holds the ChannelMapper that controls how the channels in
the animation clip map onto the properties of the target objects.
@@ -163,7 +162,7 @@ QChannelMapper *QAbstractClipAnimator::channelMapper() const
}
/*!
- \qmlproperty int AbstractClipAnimator::loops
+ \qmlproperty int Qt3DAnimation::AbstractClipAnimator::loops
This property holds the number of times the animation should play.
@@ -172,11 +171,29 @@ QChannelMapper *QAbstractClipAnimator::channelMapper() const
If set to QAbstractClipAnimator::Infinite, the animation will continuously
repeat until it is explicitly stopped.
*/
+/*!
+ \enum QAbstractClipAnimator::Loops
+
+ Holds the number of times the animation should play.
+ \value Infinite
+ This will repeat the loop continuously until it is explicitly
+ stopped.
+
+*/
/*!
- \property int QAbstractClipAnimator::loopCount
+ \property Qt3DAnimation::QAbstractClipAnimator::loops
- This property holds the number of times the animation should play.
+ Holds the number of times the animation should play.
+
+ The value is 1 by default: the animation will be played once and then stop.
+
+ If set to QAbstractClipAnimator::Infinite, the animation will continuously
+ repeat until it is explicitly stopped.
+*/
+
+/*!
+ Returns the number of times the animation should play.
The value is 1 by default: the animation will play through once and then stop.
@@ -188,7 +205,11 @@ int QAbstractClipAnimator::loopCount() const
Q_D(const QAbstractClipAnimator);
return d->m_loops;
}
+/*!
+ \property Qt3DAnimation::QAbstractClipAnimator::clock
+ The clock controls the speed with which an animation is played.
+*/
QClock *QAbstractClipAnimator::clock() const
{
Q_D(const QAbstractClipAnimator);