diff options
author | Mitch Curtis <mitch.curtis@qt.io> | 2018-03-12 11:05:08 +0100 |
---|---|---|
committer | Shawn Rutledge <shawn.rutledge@qt.io> | 2018-03-16 06:54:23 +0000 |
commit | 62dd8b20055fd5ccec1dc2eb33523aae2e6ad7b9 (patch) | |
tree | 8f1573d7cdc70da2b6ec482db67f83825f41b941 /src/quick/items/qquickspritesequence.cpp | |
parent | 936570a3b3440ed2508bacb9b9916381cb864ffb (diff) |
Improve SpriteSequence's documentation
Change-Id: I7e9e09ba3b6c0ec3c0b4bed75b24ed87fbe9660f
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Diffstat (limited to 'src/quick/items/qquickspritesequence.cpp')
-rw-r--r-- | src/quick/items/qquickspritesequence.cpp | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/src/quick/items/qquickspritesequence.cpp b/src/quick/items/qquickspritesequence.cpp index 0a39c09ebc..72761ab82b 100644 --- a/src/quick/items/qquickspritesequence.cpp +++ b/src/quick/items/qquickspritesequence.cpp @@ -73,38 +73,38 @@ QT_BEGIN_NAMESPACE Whether the sprite is animating or not. - Default is true + Default is \c true. */ /*! \qmlproperty bool QtQuick::SpriteSequence::interpolate - If true, interpolation will occur between sprite frames to make the + If \c true, interpolation will occur between sprite frames to make the animation appear smoother. - Default is true. + Default is \c true. */ /*! \qmlproperty string QtQuick::SpriteSequence::currentSprite - The name of the Sprite which is currently animating. + The name of the \l Sprite that is currently animating. */ /*! \qmlproperty string QtQuick::SpriteSequence::goalSprite - The name of the Sprite which the animation should move to. + The name of the \l Sprite that the animation should move to. - Sprite states have defined durations and transitions between them, setting goalState - will cause it to disregard any path weightings (including 0) and head down the path - which will reach the goalState quickest (fewest animations). It will pass through + Sprite states have defined durations and transitions between them; setting \c goalSprite + will cause it to disregard any path weightings (including \c 0) and head down the path + that will reach the \c goalSprite quickest (fewest animations). It will pass through intermediate states on that path, and animate them for their duration. - If it is possible to return to the goalState from the starting point of the goalState - it will continue to do so until goalState is set to "" or an unreachable state. + If it is possible to return to the \c goalSprite from the starting point of the \c goalSprite, + it will continue to do so until \c goalSprite is set to \c "" or an unreachable state. */ /*! \qmlmethod QtQuick::SpriteSequence::jumpTo(string sprite) - This function causes the SpriteSequence to jump to the specified sprite immediately, intermediate - sprites are not played. The \a sprite argument is the name of the sprite you wish to jump to. + This function causes the SpriteSequence to jump to the specified \a sprite immediately; + intermediate sprites are not played. */ /*! \qmlproperty list<Sprite> QtQuick::SpriteSequence::sprites |