aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/canvas/doc
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2014-05-28 16:19:08 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-06-05 12:02:01 +0200
commit5f99a6388abf87c34e052f3d7e266c48852a52dd (patch)
treeb88dc0b9dc36c477d6716edf932eb328d413ad68 /examples/quick/canvas/doc
parentc9553ad7d8041c7b0fd769dc8cd0f5335d9408a3 (diff)
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 <szehowe.koh@gmail.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'examples/quick/canvas/doc')
-rw-r--r--examples/quick/canvas/doc/src/canvas.qdoc44
1 files changed, 33 insertions, 11 deletions
diff --git a/examples/quick/canvas/doc/src/canvas.qdoc b/examples/quick/canvas/doc/src/canvas.qdoc
index f3eb78e1d1..2c4bd1f752 100644
--- a/examples/quick/canvas/doc/src/canvas.qdoc
+++ b/examples/quick/canvas/doc/src/canvas.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.
@@ -32,27 +32,49 @@
\image qml-canvas-example.png
\ingroup qtquickexamples
- This is a collection of small QML examples relating to Canvas item. Each example is
- a small QML file emphasizing a particular type or feature.
+ \e Canvas is a collection of small QML examples relating to the \l Canvas
+ type. Each example is a small QML file emphasizing a particular type or
+ feature.
- Red heart demonstrates using a bezierCurve API to stroke and fill a red heart.
+ \include examples-run.qdocinc
+
+ \section1 Red heart
+
+ \e{Red heart} uses the bezier curve API to stroke and fill a red heart.
\snippet canvas/bezierCurve/bezierCurve.qml 0
- Talk bubble demonstrates using a quadraticCurveTo API to stroke and fill a customized talk bubble:
+ \section1 Talk bubble
+
+ \e{Talk bubble} uses the quadraticCurveTo() API to stroke and fill a
+ customized talk bubble:
\snippet canvas/quadraticCurveTo/quadraticCurveTo.qml 0
- This example also demonstrates the fillText API:
+
+ This example also demonstrates the fillText() API:
\snippet canvas/quadraticCurveTo/quadraticCurveTo.qml 1
- Squircle demonstrates using a collection of simple moveTo/lineTo path APIs to draw a smooth squircle.
+ \section1 Squircle
+
+ \e Squircle uses a collection of simple moveTo() and lineTo() path APIs to
+ draw a smooth squircle.
- Rounded rectangle demonstrates using a collection if lineTo/arcTo path APIs to draw a rounded rectangle.
+ \section1 Rounded rectangle
- Smile face demonstrates using several complex path APIs to draw an fill a smile face.
+ \e{Rounded rectangle} uses a collection of lineTo() and arcTo() path APIs to
+ draw a rounded rectangle.
- Clip demonstrates using clip API to clip a given image.
+ \section1 Smile face
+
+ \e{Smile face} uses several paths to draw and fill a smiling face.
+
+ \section1 Clip
+
+ \e Clip uses the clip API to clip a given image.
\snippet canvas/clip/clip.qml 0
- Tiger demonstrates using SVG path API to draw a tiger with a collection of SVG path strings.
+ \section1 Tiger
+
+ \e Tiger uses the SVG path API to draw a tiger with a collection
+ of SVG path strings.
\snippet canvas/tiger/tiger.qml 0
*/