Doc: Improved Qt Quick Demos documentation

-added include from qtbase/doc/global about running the example.
-added link to "QML Applications" (main landing page for QML)
-highlighted the names with \e
-various documentation changes

Task-number: QTBUG-33597
Change-Id: I9e23b8b61862c424f2a17003b3d1f5b2ef931ceb
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>

9 files changed, 78 insertions, 31 deletions

diff --git a/examples/quick/demos/calqlatr/doc/src/calqlatr.qdoc b/examples/quick/demos/calqlatr/doc/src/calqlatr.qdoc
index 533ba99f7a..ff8061e2ea 100644
--- a/examples/quick/demos/calqlatr/doc/src/calqlatr.qdoc
+++ b/examples/quick/demos/calqlatr/doc/src/calqlatr.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.
@@ -29,9 +29,14 @@
     \title Qt Quick Demo - Calqlatr
     \ingroup qtquickdemos
     \example demos/calqlatr
-    \brief A simple calculator app, designed for portrait devices.
+    \brief A simple QML calculator app, designed for portrait devices.
     \image qtquick-demo-calqlatr.png
 
-    This app has the logic implemented in JavaScript and the appearance implemented in QML.
-*/
+    \e{Calqlatr} demonstrates various QML and \l{Qt Quick} features such as
+    displaying custom components. The logic is implemented in JavaScript and the
+    appearance implemented in QML.
+
+    \include examples-run.qdocinc
 
+    \sa {QML Applications}
+*/
diff --git a/examples/quick/demos/clocks/doc/src/clocks.qdoc b/examples/quick/demos/clocks/doc/src/clocks.qdoc
index b34f844cc6..b57894c5d3 100644
--- a/examples/quick/demos/clocks/doc/src/clocks.qdoc
+++ b/examples/quick/demos/clocks/doc/src/clocks.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.
@@ -29,7 +29,13 @@
     \title Qt Quick Demo - Clocks
     \ingroup qtquickdemos
     \example demos/clocks
-    \brief An app that shows the current time in different cities.
+    \brief A QML application that shows the current time in different cities.
     \image qtquick-demo-clocks-small.png
-*/
 
+    \e Clocks demonstrates various QML and \l{Qt Quick} features such as
+    displaying custom components.
+
+    \include examples-run.qdocinc
+
+    \sa {QML Applications}
+*/
diff --git a/examples/quick/demos/maroon/doc/src/maroon.qdoc b/examples/quick/demos/maroon/doc/src/maroon.qdoc
index c18b6bc874..59f6397dcf 100644
--- a/examples/quick/demos/maroon/doc/src/maroon.qdoc
+++ b/examples/quick/demos/maroon/doc/src/maroon.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,5 +32,11 @@
     \brief A cute game designed for touchscreens.
     \image qtquick-demo-maroon-med-1.png
     \image qtquick-demo-maroon-med-2.png
-*/
 
+    \e{Maroon in Trouble} demonstrates various QML and \l{Qt Quick} features
+    such as displaying custom components and playing sound effects.
+
+    \include examples-run.qdocinc
+
+    \sa {QML Applications}
+*/
diff --git a/examples/quick/demos/photosurface/doc/src/photosurface.qdoc b/examples/quick/demos/photosurface/doc/src/photosurface.qdoc
index 48f8e8a14b..d56b34365d 100644
--- a/examples/quick/demos/photosurface/doc/src/photosurface.qdoc
+++ b/examples/quick/demos/photosurface/doc/src/photosurface.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2012 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,6 +32,10 @@
     \brief A touch-based app for shuffling photos around a virtual surface.
     \image qtquick-demo-photosurface-small.png
 
-    This example demonstrates how to handle dragging, rotation and
-    pinch zooming within the same item using a PinchArea containing a MouseArea.
+    \e{Photo Surface} demonstrates how to handle dragging, rotation and pinch
+    zooming within the same item using a \l PinchArea containing a \l MouseArea.
+
+    \include examples-run.qdocinc
+
+    \sa {QML Applications}
 */
diff --git a/examples/quick/demos/photoviewer/doc/src/photoviewer.qdoc b/examples/quick/demos/photoviewer/doc/src/photoviewer.qdoc
index b0f1368a1c..29c432be3c 100644
--- a/examples/quick/demos/photoviewer/doc/src/photoviewer.qdoc
+++ b/examples/quick/demos/photoviewer/doc/src/photoviewer.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.
@@ -29,7 +29,13 @@
     \title Qt Quick Demo - Photo Viewer
     \ingroup qtquickdemos
     \example demos/photoviewer
-    \brief An online photo viewer that displays Flickr feeds.
+    \brief A photo viewer that displays Flickr feeds.
     \image qtquick-demo-photoviewer-small.png
-*/
 
+    \e{Photo Viewer} demonstrates various QML and \l{Qt Quick} features such as
+    displaying custom components.
+
+    \include examples-run.qdocinc
+
+    \sa {QML Applications}
+*/
diff --git a/examples/quick/demos/rssnews/doc/src/rssnews.qdoc b/examples/quick/demos/rssnews/doc/src/rssnews.qdoc
index 019b54d609..12c7c0d19b 100644
--- a/examples/quick/demos/rssnews/doc/src/rssnews.qdoc
+++ b/examples/quick/demos/rssnews/doc/src/rssnews.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.
@@ -29,7 +29,13 @@
     \title Qt Quick Demo - RSS News
     \ingroup qtquickdemos
     \example demos/rssnews
-    \brief An RSS news reader.
+    \brief A QML RSS news reader.
     \image qtquick-demo-rssnews-small.png
-*/
 
+    \e{RSS News} demonstrates various QML and \l{Qt Quick} features such as
+    loading XML data and displaying custom components.
+
+    \include examples-run.qdocinc
+
+    \sa {QML Applications}
+*/
diff --git a/examples/quick/demos/samegame/doc/src/samegame.qdoc b/examples/quick/demos/samegame/doc/src/samegame.qdoc
index 70042d73f0..acae8d728f 100644
--- a/examples/quick/demos/samegame/doc/src/samegame.qdoc
+++ b/examples/quick/demos/samegame/doc/src/samegame.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.
@@ -30,7 +30,15 @@
     \ingroup qtquickdemos
     \example demos/samegame
     \brief A QML implementation of the popular puzzle game by Kuniaki Moribe.
+
+    \e{Same Game} demonstrates a QML game with custom types and logic written in
+    JavaScript. The game uses various \l{Qt Quick} features such as
+    particles, animation, and loading images.
+
     \image qtquick-demo-samegame-med-1.png
     \image qtquick-demo-samegame-med-2.png
-*/
 
+    \include examples-run.qdocinc
+
+    \sa {QML Applications}
+*/
diff --git a/examples/quick/demos/stocqt/doc/src/stocqt.qdoc b/examples/quick/demos/stocqt/doc/src/stocqt.qdoc
index 7001bfb395..5f090e84f9 100644
--- a/examples/quick/demos/stocqt/doc/src/stocqt.qdoc
+++ b/examples/quick/demos/stocqt/doc/src/stocqt.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,5 +31,11 @@
     \example demos/stocqt
     \brief A configurable stock chart for the NASDAQ-100.
     \image qtquick-demo-stocqt.png
-*/
 
+    \e{StocQt} demonstrates various QML and \l{Qt Quick} features such as
+    displaying custom components and downloading data from the internet.
+
+    \include examples-run.qdocinc
+
+    \sa {QML Applications}
+*/
diff --git a/examples/quick/demos/tweetsearch/doc/src/tweetsearch.qdoc b/examples/quick/demos/tweetsearch/doc/src/tweetsearch.qdoc
index a56ed0d7e9..41c6c09dea 100644
--- a/examples/quick/demos/tweetsearch/doc/src/tweetsearch.qdoc
+++ b/examples/quick/demos/tweetsearch/doc/src/tweetsearch.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.
@@ -33,22 +33,20 @@
     \image qtquick-demo-tweetsearch-med-1.png
     \image qtquick-demo-tweetsearch-med-2.png
 
-    \section1 Demo Introduction
-
-    The Tweet Search demo searches items posted to Twitter service
-    using a number of query parameters. Search can be done for tweets
-    from a specified user, a hashtag or a search phrase.
+    \e{Tweet Search} is a QML application that searches items posted to Twitter
+    service using a number of query parameters. Search can be done for tweets
+    from a specified user, a hashtag, or a search phrase.
 
     The search result is a list of items showing the contents of the
     tweet as well as the name and image of the user who posted it.
     Hashtags, names and links in the content are clickable. Clicking
     on the image will flip the item to reveal more information.
 
-    \section1 Running the Demo
+    \include examples-run.qdocinc
 
     Tweet Search uses Twitter API v1.1 for running seaches.
 
-    \section2 Authentication
+    \section1 Request Authentication
 
     Each request must be authenticated on behalf of the application.
     For demonstration purposes, the application uses a hard-coded
@@ -67,7 +65,7 @@
 
     Rebuild and run the demo.
 
-    \section2 JSON Parsing
+    \section1 JSON Parsing
 
     Search results are returned in JSON (JavaScript Object Notation)
     format. \c TweetsModel uses an \l XMLHTTPRequest object to send
@@ -76,4 +74,6 @@
     representing a tweet is then added to a \l ListModel:
 
     \snippet demos/tweetsearch/content/TweetsModel.qml requesting
+
+    \sa {QML Applications}
 */