From 5f99a6388abf87c34e052f3d7e266c48852a52dd Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 28 May 2014 16:19:08 +0200 Subject: Doc: Updated "Qt Quick Examples" pages. -added instructions about running the example (using \include) -used the example names as sections in the collection pages -general editing and documentation polishing -updated copyright information Change-Id: I044f29fcc1921a541040505d5821acb06dc4cb35 Reviewed-by: Sze Howe Koh Reviewed-by: Jerome Pasion --- .../quick/imageelements/doc/src/imageelements.qdoc | 44 ++++++++++++++-------- 1 file changed, 29 insertions(+), 15 deletions(-) (limited to 'examples/quick/imageelements') diff --git a/examples/quick/imageelements/doc/src/imageelements.qdoc b/examples/quick/imageelements/doc/src/imageelements.qdoc index d88201faf9..07c09a02db 100644 --- a/examples/quick/imageelements/doc/src/imageelements.qdoc +++ b/examples/quick/imageelements/doc/src/imageelements.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. @@ -31,29 +31,43 @@ \image qml-imageelements-example.png \ingroup qtquickexamples - This is a collection of small QML examples relating to image types. + \e{Image Elements} is a collection of small QML examples relating to image + types. For more information, visit \l{Use Case - Visual Elements In QML}. - 'BorderImage' shows off the various scaling modes of the BorderImage item - by setting its horizontalTileMode and verticalTileMode properties. + \include examples-run.qdocinc - 'Image' shows off the various fill modes of the Image item. + \section1 BorderImage - 'Shadows' shows how to create a drop shadow effect for a rectangular item - using a BorderImage: + \e BorderImage shows off the various scaling modes of the \l BorderImage + type by setting its horizontalTileMode and verticalTileMode properties. + + \section1 Image + + \e Image shows off the various fill modes of the \l Image type. + + \section1 Shadows + + \e Shadows shows how to create a drop shadow effect for a rectangular item + using a \l BorderImage: \snippet imageelements/content/ShadowRectangle.qml shadow - 'AnimatedSprite' shows how to display a simple animation using an - AnimatedSprite object: + \section1 AnimatedSprite + + \e AnimatedSprite shows how to display a simple animation using an + \l AnimatedSprite object: \snippet imageelements/animatedsprite.qml sprite - The sprite animation will loop 3 times. + The sprite animation will loop three times. + + \section1 SpriteSequence - 'SpriteSequence' demonstrates using a sprite sequence to draw an animated - and interactive bear. - The SpriteSequence defines 5 different sprites. The bear is initially in - a 'still' state: + \e SpriteSequence demonstrates using a sprite sequence to draw an animated + and interactive bear. The \l SpriteSequence object defines five different + sprites. The bear is initially in a \e still state: \snippet imageelements/spritesequence.qml still + When the scene is clicked, an animation sets the sprite sequence to the - 'falling' states and animates the bear's y property. + \e falling states and animates the bear's y property. \snippet imageelements/spritesequence.qml animation + At the end of the animation the bear is set back to its initial state. */ -- cgit v1.2.3