Doc: Make Qt Quick demos accessible from Qt documentation
authorSze Howe Koh <szehowe.koh@gmail.com>
Tue, 30 Apr 2013 15:35:41 +0000 (23:35 +0800)
committerThe Qt Project <gerrit-noreply@qt-project.org>
Tue, 7 May 2013 13:57:48 +0000 (15:57 +0200)
Add screenshots and brief descriptions. Integrate source code into
documentation.

Create new group, "qtquickdemos".

Change-Id: I92715b2cdd861b1ff2bdd28a640e63d2a220499e
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
18 files changed:
examples/quick/demos/clocks/doc/images/qtquick-demo-clocks-small.png [new file with mode: 0644]
examples/quick/demos/clocks/doc/src/clocks.qdoc [new file with mode: 0644]
examples/quick/demos/maroon/doc/images/qtquick-demo-maroon-med-1.png [new file with mode: 0644]
examples/quick/demos/maroon/doc/images/qtquick-demo-maroon-med-2.png [new file with mode: 0644]
examples/quick/demos/maroon/doc/src/maroon.qdoc [new file with mode: 0644]
examples/quick/demos/photoviewer/doc/images/qtquick-demo-photoviewer-small.png [new file with mode: 0644]
examples/quick/demos/photoviewer/doc/src/photoviewer.qdoc [new file with mode: 0644]
examples/quick/demos/rssnews/doc/images/qtquick-demo-rssnews-small.png [new file with mode: 0644]
examples/quick/demos/rssnews/doc/src/rssnews.qdoc [new file with mode: 0644]
examples/quick/demos/samegame/doc/images/qtquick-demo-samegame-med-1.png [new file with mode: 0644]
examples/quick/demos/samegame/doc/images/qtquick-demo-samegame-med-2.png [new file with mode: 0644]
examples/quick/demos/samegame/doc/src/samegame.qdoc [new file with mode: 0644]
examples/quick/demos/stocqt/doc/images/qtquick-demo-stocqt.png [new file with mode: 0644]
examples/quick/demos/stocqt/doc/src/stocqt.qdoc [new file with mode: 0644]
examples/quick/demos/tweetsearch/doc/images/qtquick-demo-tweetsearch-med-1.png [new file with mode: 0644]
examples/quick/demos/tweetsearch/doc/images/qtquick-demo-tweetsearch-med-2.png [new file with mode: 0644]
examples/quick/demos/tweetsearch/doc/src/tweetsearch.qdoc [new file with mode: 0644]
src/quick/doc/src/examples.qdoc

diff --git a/examples/quick/demos/clocks/doc/images/qtquick-demo-clocks-small.png b/examples/quick/demos/clocks/doc/images/qtquick-demo-clocks-small.png
new file mode 100644 (file)
index 0000000..94b641d
Binary files /dev/null and b/examples/quick/demos/clocks/doc/images/qtquick-demo-clocks-small.png differ
diff --git a/examples/quick/demos/clocks/doc/src/clocks.qdoc b/examples/quick/demos/clocks/doc/src/clocks.qdoc
new file mode 100644 (file)
index 0000000..b34f844
--- /dev/null
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 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.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \title Qt Quick Demo - Clocks
+    \ingroup qtquickdemos
+    \example demos/clocks
+    \brief An app that shows the current time in different cities.
+    \image qtquick-demo-clocks-small.png
+*/
+
diff --git a/examples/quick/demos/maroon/doc/images/qtquick-demo-maroon-med-1.png b/examples/quick/demos/maroon/doc/images/qtquick-demo-maroon-med-1.png
new file mode 100644 (file)
index 0000000..6d41179
Binary files /dev/null and b/examples/quick/demos/maroon/doc/images/qtquick-demo-maroon-med-1.png differ
diff --git a/examples/quick/demos/maroon/doc/images/qtquick-demo-maroon-med-2.png b/examples/quick/demos/maroon/doc/images/qtquick-demo-maroon-med-2.png
new file mode 100644 (file)
index 0000000..c8f3748
Binary files /dev/null and b/examples/quick/demos/maroon/doc/images/qtquick-demo-maroon-med-2.png differ
diff --git a/examples/quick/demos/maroon/doc/src/maroon.qdoc b/examples/quick/demos/maroon/doc/src/maroon.qdoc
new file mode 100644 (file)
index 0000000..c18b6bc
--- /dev/null
@@ -0,0 +1,36 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 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.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \title Qt Quick Demo - Maroon in Trouble
+    \ingroup qtquickdemos
+    \example demos/maroon
+    \brief A cute game designed for touchscreens.
+    \image qtquick-demo-maroon-med-1.png
+    \image qtquick-demo-maroon-med-2.png
+*/
+
diff --git a/examples/quick/demos/photoviewer/doc/images/qtquick-demo-photoviewer-small.png b/examples/quick/demos/photoviewer/doc/images/qtquick-demo-photoviewer-small.png
new file mode 100644 (file)
index 0000000..d872310
Binary files /dev/null and b/examples/quick/demos/photoviewer/doc/images/qtquick-demo-photoviewer-small.png differ
diff --git a/examples/quick/demos/photoviewer/doc/src/photoviewer.qdoc b/examples/quick/demos/photoviewer/doc/src/photoviewer.qdoc
new file mode 100644 (file)
index 0000000..b0f1368
--- /dev/null
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 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.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \title Qt Quick Demo - Photo Viewer
+    \ingroup qtquickdemos
+    \example demos/photoviewer
+    \brief An online photo viewer that displays Flickr feeds.
+    \image qtquick-demo-photoviewer-small.png
+*/
+
diff --git a/examples/quick/demos/rssnews/doc/images/qtquick-demo-rssnews-small.png b/examples/quick/demos/rssnews/doc/images/qtquick-demo-rssnews-small.png
new file mode 100644 (file)
index 0000000..0ad6c02
Binary files /dev/null and b/examples/quick/demos/rssnews/doc/images/qtquick-demo-rssnews-small.png differ
diff --git a/examples/quick/demos/rssnews/doc/src/rssnews.qdoc b/examples/quick/demos/rssnews/doc/src/rssnews.qdoc
new file mode 100644 (file)
index 0000000..019b54d
--- /dev/null
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 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.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \title Qt Quick Demo - RSS News
+    \ingroup qtquickdemos
+    \example demos/rssnews
+    \brief An RSS news reader.
+    \image qtquick-demo-rssnews-small.png
+*/
+
diff --git a/examples/quick/demos/samegame/doc/images/qtquick-demo-samegame-med-1.png b/examples/quick/demos/samegame/doc/images/qtquick-demo-samegame-med-1.png
new file mode 100644 (file)
index 0000000..cce9f11
Binary files /dev/null and b/examples/quick/demos/samegame/doc/images/qtquick-demo-samegame-med-1.png differ
diff --git a/examples/quick/demos/samegame/doc/images/qtquick-demo-samegame-med-2.png b/examples/quick/demos/samegame/doc/images/qtquick-demo-samegame-med-2.png
new file mode 100644 (file)
index 0000000..ca9e836
Binary files /dev/null and b/examples/quick/demos/samegame/doc/images/qtquick-demo-samegame-med-2.png differ
diff --git a/examples/quick/demos/samegame/doc/src/samegame.qdoc b/examples/quick/demos/samegame/doc/src/samegame.qdoc
new file mode 100644 (file)
index 0000000..70042d7
--- /dev/null
@@ -0,0 +1,36 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 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.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \title Qt Quick Demo - Same Game
+    \ingroup qtquickdemos
+    \example demos/samegame
+    \brief A QML implementation of the popular puzzle game by Kuniaki Moribe.
+    \image qtquick-demo-samegame-med-1.png
+    \image qtquick-demo-samegame-med-2.png
+*/
+
diff --git a/examples/quick/demos/stocqt/doc/images/qtquick-demo-stocqt.png b/examples/quick/demos/stocqt/doc/images/qtquick-demo-stocqt.png
new file mode 100644 (file)
index 0000000..1783881
Binary files /dev/null and b/examples/quick/demos/stocqt/doc/images/qtquick-demo-stocqt.png differ
diff --git a/examples/quick/demos/stocqt/doc/src/stocqt.qdoc b/examples/quick/demos/stocqt/doc/src/stocqt.qdoc
new file mode 100644 (file)
index 0000000..7001bfb
--- /dev/null
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 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.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \title Qt Quick Demo - StocQt
+    \ingroup qtquickdemos
+    \example demos/stocqt
+    \brief A configurable stock chart for the NASDAQ-100.
+    \image qtquick-demo-stocqt.png
+*/
+
diff --git a/examples/quick/demos/tweetsearch/doc/images/qtquick-demo-tweetsearch-med-1.png b/examples/quick/demos/tweetsearch/doc/images/qtquick-demo-tweetsearch-med-1.png
new file mode 100644 (file)
index 0000000..930ee39
Binary files /dev/null and b/examples/quick/demos/tweetsearch/doc/images/qtquick-demo-tweetsearch-med-1.png differ
diff --git a/examples/quick/demos/tweetsearch/doc/images/qtquick-demo-tweetsearch-med-2.png b/examples/quick/demos/tweetsearch/doc/images/qtquick-demo-tweetsearch-med-2.png
new file mode 100644 (file)
index 0000000..9eff191
Binary files /dev/null and b/examples/quick/demos/tweetsearch/doc/images/qtquick-demo-tweetsearch-med-2.png differ
diff --git a/examples/quick/demos/tweetsearch/doc/src/tweetsearch.qdoc b/examples/quick/demos/tweetsearch/doc/src/tweetsearch.qdoc
new file mode 100644 (file)
index 0000000..9ba252f
--- /dev/null
@@ -0,0 +1,36 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 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.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \title Qt Quick Demo - Tweet Search
+    \ingroup qtquickdemos
+    \example demos/tweetsearch
+    \brief A Twitter search client with 3D effects.
+    \image qtquick-demo-tweetsearch-med-1.png
+    \image qtquick-demo-tweetsearch-med-2.png
+*/
+
index 8d3bc30..ddca973 100644 (file)
@@ -38,10 +38,13 @@ These are code samples that show how to use various aspects of Qt Quick. Larger
 compound interfaces are grouped as applications as they demonstrate more Qt
 Quick features.
 
+Here is a list of fully-functional demo applications.
 To run the sample applications, open them in Qt Creator or use the included
 \l {Prototyping with qmlscene}{qmlscene} tool.
 
-Some of these code samples have a corresponding \l{qtquick-tutorials}{tutorial}.
+\annotatedlist{qtquickdemos}
+
+Some of these code samples below  have a corresponding \l{qtquick-tutorials}{tutorial}.
 The Qt Quick features are covered in the \l {qtquick-overviews}{main page}.
 This set of code samples are part of the collection of \l{Qt Examples}.