summaryrefslogtreecommitdiffstats
path: root/examples/widgets/doc
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2012-12-06 19:27:20 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-12-11 10:37:51 +0100
commit6a9eb8ed01e002393b2fb26838cefadf8d41f036 (patch)
tree42ddb4c2860db75fc4c75c68e38801091fcefe5c /examples/widgets/doc
parent5b3e7c8dfa4856b04013ace24d19bbd104dc3bd0 (diff)
Doc: Added documentation for the examples
- Moved documentation for the Qt XML, Qt Widgets, Qt Concurrent, and Qt Network examples from qtdoc. - Grouped the documentation pages under relevant groups - Fixed \snippet paths Task-number: QTBUG-27515 Change-Id: I43c22a679e2eefbb48e3cd5893aa2afd3d905863 Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
Diffstat (limited to 'examples/widgets/doc')
-rw-r--r--examples/widgets/doc/images/graphicsanchorlayout-example.pngbin0 -> 11592 bytes
-rw-r--r--examples/widgets/doc/images/graphicsflowlayout-example.pngbin0 -> 15345 bytes
-rw-r--r--examples/widgets/doc/images/graphicssimpleanchorlayout-example.pngbin0 -> 13715 bytes
-rw-r--r--examples/widgets/doc/images/weatheranchorlayout-example.pngbin0 -> 88805 bytes
-rw-r--r--examples/widgets/doc/src/basicgraphicslayouts.qdoc4
-rw-r--r--examples/widgets/doc/src/blurpicker.qdoc2
-rw-r--r--examples/widgets/doc/src/boxes.qdoc3
-rw-r--r--examples/widgets/doc/src/chip.qdoc5
-rw-r--r--examples/widgets/doc/src/collidingmice-example.qdoc2
-rw-r--r--examples/widgets/doc/src/diagramscene.qdoc2
-rw-r--r--examples/widgets/doc/src/dragdroprobot.qdoc4
-rw-r--r--examples/widgets/doc/src/elasticnodes.qdoc6
-rw-r--r--examples/widgets/doc/src/embeddeddialogs.qdoc6
-rw-r--r--examples/widgets/doc/src/fademessage.qdoc4
-rw-r--r--examples/widgets/doc/src/graphicsview-anchorlayout.qdoc4
-rw-r--r--examples/widgets/doc/src/graphicsview-flowlayout.qdoc4
-rw-r--r--examples/widgets/doc/src/graphicsview-simpleanchorlayout.qdoc4
-rw-r--r--examples/widgets/doc/src/graphicsview-weatheranchorlayout.qdoc4
-rw-r--r--examples/widgets/doc/src/lighting.qdoc2
-rw-r--r--examples/widgets/doc/src/padnavigator.qdoc4
20 files changed, 36 insertions, 24 deletions
diff --git a/examples/widgets/doc/images/graphicsanchorlayout-example.png b/examples/widgets/doc/images/graphicsanchorlayout-example.png
new file mode 100644
index 0000000000..d30d6839d9
--- /dev/null
+++ b/examples/widgets/doc/images/graphicsanchorlayout-example.png
Binary files differ
diff --git a/examples/widgets/doc/images/graphicsflowlayout-example.png b/examples/widgets/doc/images/graphicsflowlayout-example.png
new file mode 100644
index 0000000000..a5f9b3dc40
--- /dev/null
+++ b/examples/widgets/doc/images/graphicsflowlayout-example.png
Binary files differ
diff --git a/examples/widgets/doc/images/graphicssimpleanchorlayout-example.png b/examples/widgets/doc/images/graphicssimpleanchorlayout-example.png
new file mode 100644
index 0000000000..d073b12c0c
--- /dev/null
+++ b/examples/widgets/doc/images/graphicssimpleanchorlayout-example.png
Binary files differ
diff --git a/examples/widgets/doc/images/weatheranchorlayout-example.png b/examples/widgets/doc/images/weatheranchorlayout-example.png
new file mode 100644
index 0000000000..59d3b55b7a
--- /dev/null
+++ b/examples/widgets/doc/images/weatheranchorlayout-example.png
Binary files differ
diff --git a/examples/widgets/doc/src/basicgraphicslayouts.qdoc b/examples/widgets/doc/src/basicgraphicslayouts.qdoc
index 2ff9a90680..70f92a838a 100644
--- a/examples/widgets/doc/src/basicgraphicslayouts.qdoc
+++ b/examples/widgets/doc/src/basicgraphicslayouts.qdoc
@@ -29,9 +29,9 @@
\example graphicsview/basicgraphicslayouts
\title Basic Graphics Layouts Example
\ingroup examples-graphicsview-layout
- \brief This example shows how to use some basic layouts.
+ \brief Demonstrates how to create basic graphics layout
- \brief The Basic Graphics Layouts example shows how to use the layout classes
+ The Basic Graphics Layouts example shows how to use the layout classes
in QGraphicsView: QGraphicsLinearLayout and QGraphicsGridLayout.
In addition to that it shows how to write your own custom layout item.
diff --git a/examples/widgets/doc/src/blurpicker.qdoc b/examples/widgets/doc/src/blurpicker.qdoc
index bacd7474e3..06426c2ab3 100644
--- a/examples/widgets/doc/src/blurpicker.qdoc
+++ b/examples/widgets/doc/src/blurpicker.qdoc
@@ -29,7 +29,7 @@
\example effects/blurpicker
\title Blur Picker Effect Example
\ingroup examples-graphicsview-graphicseffects
- \brief This example shows the use of QGraphicsBlurEffect.
+ \brief Demonstrates how to apply graphical effects on items in the view
\image blurpickereffect-example.png
*/
diff --git a/examples/widgets/doc/src/boxes.qdoc b/examples/widgets/doc/src/boxes.qdoc
index b3ed1f68c8..6ad50fff9f 100644
--- a/examples/widgets/doc/src/boxes.qdoc
+++ b/examples/widgets/doc/src/boxes.qdoc
@@ -29,8 +29,7 @@
\example graphicsview/boxes
\title Boxes
\ingroup examples-graphicsview
- \brief This demo shows Qt's ability to combine advanced OpenGL rendering with the
- the \l{Graphics View Framework}.
+ \brief Combines advanced OpenGL rendering with the Graphics View framework
\image boxes-demo.png
diff --git a/examples/widgets/doc/src/chip.qdoc b/examples/widgets/doc/src/chip.qdoc
index e3adb26ced..6fd15ac09c 100644
--- a/examples/widgets/doc/src/chip.qdoc
+++ b/examples/widgets/doc/src/chip.qdoc
@@ -29,10 +29,9 @@
\example graphicsview/chip
\title 40000 Chips
\ingroup examples-graphicsview
- \brief This demo shows how to visualize a huge scene with 40000 chip items
- using Graphics View.
+ \brief Visualizes a huge graphic view scene with 40000 chip items
- It also shows Graphics View's powerful navigation
+ This examples demonstrates Graphics View's powerful navigation
and interaction features, allowing you to zoom and rotate each of four
views independently, and you can select and move items around the scene.
diff --git a/examples/widgets/doc/src/collidingmice-example.qdoc b/examples/widgets/doc/src/collidingmice-example.qdoc
index 3994d75c2b..b6187677b8 100644
--- a/examples/widgets/doc/src/collidingmice-example.qdoc
+++ b/examples/widgets/doc/src/collidingmice-example.qdoc
@@ -28,6 +28,8 @@
/*!
\example graphicsview/collidingmice
\title Colliding Mice Example
+ \brief Demonstrates how to animate items on a graphics view
+ \ingroup examples-graphicsview
The Colliding Mice example shows how to use the Graphics View
framework to implement animated items and detect collision between
diff --git a/examples/widgets/doc/src/diagramscene.qdoc b/examples/widgets/doc/src/diagramscene.qdoc
index 55043df475..4ad74cfee9 100644
--- a/examples/widgets/doc/src/diagramscene.qdoc
+++ b/examples/widgets/doc/src/diagramscene.qdoc
@@ -29,7 +29,7 @@
\example graphicsview/diagramscene
\title Diagram Scene Example
\ingroup examples-graphicsview
- \brief This example shows use of Qt's graphics framework.
+ \brief Demonstrate how to use the Graphics View framework
\image diagramscene.png
diff --git a/examples/widgets/doc/src/dragdroprobot.qdoc b/examples/widgets/doc/src/dragdroprobot.qdoc
index 8187cbfd46..f58f3cfdf2 100644
--- a/examples/widgets/doc/src/dragdroprobot.qdoc
+++ b/examples/widgets/doc/src/dragdroprobot.qdoc
@@ -29,7 +29,9 @@
\example graphicsview/dragdroprobot
\title Drag and Drop Robot Example
\ingroup examples-graphicsview
- \brief The Drag and Drop Robot example shows how to implement Drag and Drop in a
+ \brief Demonstrates how to drag and drop items in a graphics view
+
+ The Drag and Drop Robot example shows how to implement Drag and Drop in a
QGraphicsItem subclass, as well as how to animate items using Qt's
\l{Animation Framework}.
diff --git a/examples/widgets/doc/src/elasticnodes.qdoc b/examples/widgets/doc/src/elasticnodes.qdoc
index 75ad496592..bfca70d2f1 100644
--- a/examples/widgets/doc/src/elasticnodes.qdoc
+++ b/examples/widgets/doc/src/elasticnodes.qdoc
@@ -29,10 +29,10 @@
\example graphicsview/elasticnodes
\title Elastic Nodes Example
\ingroup examples-graphicsview
- \brief The Elastic Nodes example shows how to implement edges between nodes in a
- graph, with basic interaction.
+ \brief Demonstrates how to interact with graphical items in a scene
- You can click to drag a node around, and
+ The Elastic Nodes example shows how to implement edges between nodes in a
+ graph, with basic interaction. You can click to drag a node around, and
zoom in and out using the mouse wheel or the keyboard. Hitting the space
bar will randomize the nodes. The example is also resolution independent;
as you zoom in, the graphics remain crisp.
diff --git a/examples/widgets/doc/src/embeddeddialogs.qdoc b/examples/widgets/doc/src/embeddeddialogs.qdoc
index 1dbb7dc83a..34e800d75a 100644
--- a/examples/widgets/doc/src/embeddeddialogs.qdoc
+++ b/examples/widgets/doc/src/embeddeddialogs.qdoc
@@ -29,10 +29,10 @@
\example graphicsview/embeddeddialogs
\title Embedded Dialogs
\ingroup examples-graphicsview-layout
- \brief This example shows how to embed standard dialogs into
- Graphics View.
+ \brief Demonstrates how to embed dialogs into a graphics view
- It also shows how you can customize the
+ This example shows how to embed standard dialogs into
+ Graphics View. It also shows how you can customize the
proxy class and add window shadows.
\image embeddeddialogs-demo.png
diff --git a/examples/widgets/doc/src/fademessage.qdoc b/examples/widgets/doc/src/fademessage.qdoc
index 335384d5bd..dcd429521d 100644
--- a/examples/widgets/doc/src/fademessage.qdoc
+++ b/examples/widgets/doc/src/fademessage.qdoc
@@ -29,9 +29,9 @@
\example effects/fademessage
\title Fade Message Effect Example
\ingroup examples-graphicsview-graphicseffects
- \brief This example shows the use of QGraphicsColorizeEffect.
+ \brief Demonstrates how to appliy effects on items in the view
- \div { style="text-align: center"}
+ \div { style="text-align: left"}
\inlineimage fademessageeffect-example.png
\inlineimage fademessageeffect-example-faded.png
\enddiv
diff --git a/examples/widgets/doc/src/graphicsview-anchorlayout.qdoc b/examples/widgets/doc/src/graphicsview-anchorlayout.qdoc
index 78aa1feb95..98c0958918 100644
--- a/examples/widgets/doc/src/graphicsview-anchorlayout.qdoc
+++ b/examples/widgets/doc/src/graphicsview-anchorlayout.qdoc
@@ -29,8 +29,10 @@
\example graphicsview/anchorlayout
\title Anchor Layout Example
\ingroup examples-graphicsview-layout
- \brief This example shows how to use QGraphicsAnchorLayout.
+ \brief Demonstrates anchor layout in a graphics view scene
The Anchor Layout example demonstrates the use of the QGraphicsAnchorLayout
class.
+
+ \image graphicsanchorlayout-example.png
*/
diff --git a/examples/widgets/doc/src/graphicsview-flowlayout.qdoc b/examples/widgets/doc/src/graphicsview-flowlayout.qdoc
index c754fa2d53..52d97164c3 100644
--- a/examples/widgets/doc/src/graphicsview-flowlayout.qdoc
+++ b/examples/widgets/doc/src/graphicsview-flowlayout.qdoc
@@ -29,10 +29,12 @@
\example graphicsview/flowlayout
\title Graphics View Flow Layout Example
\ingroup examples-graphicsview-layout
- \brief This example shows how to make a flow layout in Graphics View.
+ \brief Demonstrates flow layout on a graphics view scene.
The Graphics View Flow Layout example shows the use of a flow layout
in a Graphics View widget.
+ \image graphicsflowlayout-example.png
+
See the \l{Flow Layout Example} for a corresponding widget-based example.
*/
diff --git a/examples/widgets/doc/src/graphicsview-simpleanchorlayout.qdoc b/examples/widgets/doc/src/graphicsview-simpleanchorlayout.qdoc
index 2ff804ab46..480c7c4e0c 100644
--- a/examples/widgets/doc/src/graphicsview-simpleanchorlayout.qdoc
+++ b/examples/widgets/doc/src/graphicsview-simpleanchorlayout.qdoc
@@ -29,8 +29,10 @@
\example graphicsview/simpleanchorlayout
\title Simple Anchor Layout Example
\ingroup examples-graphicsview-layout
- \brief This example shows how basic use of QGraphicsAnchorLayout.
+ \brief Demonstrates anchor layout on a graphics view scene
The Simple Anchor Layout example shows the basic use of the
QGraphicsAnchorLayout class.
+
+ \image graphicssimpleanchorlayout-example.png
*/
diff --git a/examples/widgets/doc/src/graphicsview-weatheranchorlayout.qdoc b/examples/widgets/doc/src/graphicsview-weatheranchorlayout.qdoc
index 8b7b9c498d..88a5c60fb5 100644
--- a/examples/widgets/doc/src/graphicsview-weatheranchorlayout.qdoc
+++ b/examples/widgets/doc/src/graphicsview-weatheranchorlayout.qdoc
@@ -29,8 +29,10 @@
\example graphicsview/weatheranchorlayout
\title Weather Anchor Layout Example
\ingroup examples-graphicsview-layout
- \brief This example shows advanced use of QGraphicsAnchorLayout.
+ \brief Demonstrates anchor layout on a graphics view scene
The Weather Anchor Layout example shows more complex use of the
QGraphicsAnchorLayout class to create a real-world window layout.
+
+ \image weatheranchorlayout-example.png
*/
diff --git a/examples/widgets/doc/src/lighting.qdoc b/examples/widgets/doc/src/lighting.qdoc
index 8277f0e5b8..e519bacb91 100644
--- a/examples/widgets/doc/src/lighting.qdoc
+++ b/examples/widgets/doc/src/lighting.qdoc
@@ -29,7 +29,7 @@
\example effects/lighting
\title Lighting Effect Example
\ingroup examples-graphicsview-graphicseffects
- \brief This example shows the use of QGraphicsDropShadowEffect.
+ \brief Demonstrates how to apply effects on items in the view
\image lightingeffect-example.png
*/
diff --git a/examples/widgets/doc/src/padnavigator.qdoc b/examples/widgets/doc/src/padnavigator.qdoc
index 90c7c00952..7b5e54e5ff 100644
--- a/examples/widgets/doc/src/padnavigator.qdoc
+++ b/examples/widgets/doc/src/padnavigator.qdoc
@@ -29,7 +29,9 @@
\example graphicsview/padnavigator
\title Pad Navigator Example
\ingroup examples-graphicsview
- \brief The Pad Navigator Example shows how you can use Graphics View together with
+ \brief Demonstrates how to create animated user interface
+
+ The Pad Navigator Example shows how you can use Graphics View together with
embedded widgets and Qt's \l{State Machine Framework} to create a simple
but useful, dynamic, animated user interface.