From d2ca3f6af3e84c6d563066d4416f4207cfde860e Mon Sep 17 00:00:00 2001
From: Bea Lam <bea.lam@nokia.com>
Date: Wed, 8 Aug 2012 16:34:21 +1000
Subject: Document some undocumented AnimatedSprite functions

Change-Id: If6ac34a989d5770b1f3e2481a01ee57ad89f7707
Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
---
 src/quick/items/qquickanimatedsprite.cpp | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

(limited to 'src')

diff --git a/src/quick/items/qquickanimatedsprite.cpp b/src/quick/items/qquickanimatedsprite.cpp
index c236d3a84f..0b82e66dc2 100644
--- a/src/quick/items/qquickanimatedsprite.cpp
+++ b/src/quick/items/qquickanimatedsprite.cpp
@@ -354,6 +354,12 @@ struct AnimatedSpriteVertices {
 
 */
 
+/*!
+    \qmlmethod int QtQuick2::AnimatedSprite::restart()
+
+    Stops, then starts the sprite animation.
+*/
+
 //TODO: Implicitly size element to size of sprite
 QQuickAnimatedSprite::QQuickAnimatedSprite(QQuickItem *parent) :
     QQuickItem(parent)
@@ -425,6 +431,11 @@ void QQuickAnimatedSprite::stop()
     emit runningChanged(false);
 }
 
+/*!
+    \qmlmethod int QtQuick2::AnimatedSprite::advance()
+
+    Advances the sprite animation by one frame.
+*/
 void QQuickAnimatedSprite::advance(int frames)
 {
     if (!frames)
@@ -437,6 +448,14 @@ void QQuickAnimatedSprite::advance(int frames)
     emit currentFrameChanged(m_curFrame);
 }
 
+/*!
+    \qmlmethod int QtQuick2::AnimatedSprite::pause()
+
+    Pauses the sprite animation. This does nothing if
+    \l paused is true.
+
+    \sa resume()
+*/
 void QQuickAnimatedSprite::pause()
 {
     if (m_paused)
@@ -446,6 +465,14 @@ void QQuickAnimatedSprite::pause()
     emit pausedChanged(true);
 }
 
+/*!
+    \qmlmethod int QtQuick2::AnimatedSprite::resume()
+
+    Resumes the sprite animation if \l paused is true;
+    otherwise, this does nothing.
+
+    \sa pause()
+*/
 void QQuickAnimatedSprite::resume()
 {
     if (!m_paused)
-- 
cgit v1.2.3