Extend QQuickSprite docs

Including links to sprite sheet generators to help designers produce
this common format.

Change-Id: I980ae8090804bcc3de5513360dde8e65f9ec2ef8
Reviewed-by: Alan Alpert <alan.alpert@nokia.com>

diff --git a/src/quick/items/qquicksprite.cpp b/src/quick/items/qquicksprite.cpp
index ac5fe5d..632ee7f 100644 (file)
--- a/src/quick/items/qquicksprite.cpp
+++ b/src/quick/items/qquicksprite.cpp
@@ -49,6 +49,20 @@ QT_BEGIN_NAMESPACE
     \inqmlmodule QtQuick 2
     \brief The Sprite element represents a sprite animation
 
+    QQuickSprite renders sprites of one or more frames and animates them. The sprites
+    can be in the middle of an image file, or split along multiple rows, as long as they form
+    a contiguous line wrapping to the next row of the file from the left edge of the file.
+
+    Sprites within one animation must be the same size, however sprites within the same file
+    do not. Sprites without a frameCount specified assume that they take the entire file.
+
+    There are several software tools to help turn images into sprite sheets, here are some examples:
+    Photoshop plugin:
+    http://www.personal.psu.edu/zez1/blogs/my_blog/2011/05/scripts-4-photoshop-file-sequence-to-layers-to-sprite-sheet.html
+    Gimp plugin:
+    http://registry.gimp.org/node/20943
+    Cmd-line tool:
+    http://www.imagemagick.org/script/montage.php
 */
 /*!
     \qmlproperty int QtQuick2::Sprite::duration