From 40d90b50c555a968f1ae540527199042fbcf1a32 Mon Sep 17 00:00:00 2001 From: Sze Howe Koh Date: Tue, 30 Apr 2013 23:35:41 +0800 Subject: Doc: Make Qt Quick demos accessible from Qt documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add screenshots and brief descriptions. Integrate source code into documentation. Create new group, "qtquickdemos". Change-Id: I92715b2cdd861b1ff2bdd28a640e63d2a220499e Reviewed-by: Topi Reiniö Reviewed-by: Jerome Pasion --- .../doc/images/qtquick-demo-clocks-small.png | Bin 0 -> 26067 bytes examples/quick/demos/clocks/doc/src/clocks.qdoc | 35 ++++++++++++++++++++ .../doc/images/qtquick-demo-maroon-med-1.png | Bin 0 -> 73390 bytes .../doc/images/qtquick-demo-maroon-med-2.png | Bin 0 -> 61303 bytes examples/quick/demos/maroon/doc/src/maroon.qdoc | 36 +++++++++++++++++++++ .../doc/images/qtquick-demo-photoviewer-small.png | Bin 0 -> 73662 bytes .../demos/photoviewer/doc/src/photoviewer.qdoc | 35 ++++++++++++++++++++ .../doc/images/qtquick-demo-rssnews-small.png | Bin 0 -> 43372 bytes examples/quick/demos/rssnews/doc/src/rssnews.qdoc | 35 ++++++++++++++++++++ .../doc/images/qtquick-demo-samegame-med-1.png | Bin 0 -> 100713 bytes .../doc/images/qtquick-demo-samegame-med-2.png | Bin 0 -> 134892 bytes .../quick/demos/samegame/doc/src/samegame.qdoc | 36 +++++++++++++++++++++ .../stocqt/doc/images/qtquick-demo-stocqt.png | Bin 0 -> 24592 bytes examples/quick/demos/stocqt/doc/src/stocqt.qdoc | 35 ++++++++++++++++++++ .../doc/images/qtquick-demo-tweetsearch-med-1.png | Bin 0 -> 18531 bytes .../doc/images/qtquick-demo-tweetsearch-med-2.png | Bin 0 -> 90622 bytes .../demos/tweetsearch/doc/src/tweetsearch.qdoc | 36 +++++++++++++++++++++ 17 files changed, 248 insertions(+) create mode 100644 examples/quick/demos/clocks/doc/images/qtquick-demo-clocks-small.png create mode 100644 examples/quick/demos/clocks/doc/src/clocks.qdoc create mode 100644 examples/quick/demos/maroon/doc/images/qtquick-demo-maroon-med-1.png create mode 100644 examples/quick/demos/maroon/doc/images/qtquick-demo-maroon-med-2.png create mode 100644 examples/quick/demos/maroon/doc/src/maroon.qdoc create mode 100644 examples/quick/demos/photoviewer/doc/images/qtquick-demo-photoviewer-small.png create mode 100644 examples/quick/demos/photoviewer/doc/src/photoviewer.qdoc create mode 100644 examples/quick/demos/rssnews/doc/images/qtquick-demo-rssnews-small.png create mode 100644 examples/quick/demos/rssnews/doc/src/rssnews.qdoc create mode 100644 examples/quick/demos/samegame/doc/images/qtquick-demo-samegame-med-1.png create mode 100644 examples/quick/demos/samegame/doc/images/qtquick-demo-samegame-med-2.png create mode 100644 examples/quick/demos/samegame/doc/src/samegame.qdoc create mode 100644 examples/quick/demos/stocqt/doc/images/qtquick-demo-stocqt.png create mode 100644 examples/quick/demos/stocqt/doc/src/stocqt.qdoc create mode 100644 examples/quick/demos/tweetsearch/doc/images/qtquick-demo-tweetsearch-med-1.png create mode 100644 examples/quick/demos/tweetsearch/doc/images/qtquick-demo-tweetsearch-med-2.png create mode 100644 examples/quick/demos/tweetsearch/doc/src/tweetsearch.qdoc (limited to 'examples/quick') 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 index 0000000000..94b641d891 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 index 0000000000..b34f844cc6 --- /dev/null +++ b/examples/quick/demos/clocks/doc/src/clocks.qdoc @@ -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 index 0000000000..6d41179c23 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 index 0000000000..c8f37486f6 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 index 0000000000..c18b6bc874 --- /dev/null +++ b/examples/quick/demos/maroon/doc/src/maroon.qdoc @@ -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 index 0000000000..d872310a3e 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 index 0000000000..b0f1368a1c --- /dev/null +++ b/examples/quick/demos/photoviewer/doc/src/photoviewer.qdoc @@ -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 index 0000000000..0ad6c02251 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 index 0000000000..019b54d609 --- /dev/null +++ b/examples/quick/demos/rssnews/doc/src/rssnews.qdoc @@ -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 index 0000000000..cce9f11017 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 index 0000000000..ca9e8368b1 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 index 0000000000..70042d73f0 --- /dev/null +++ b/examples/quick/demos/samegame/doc/src/samegame.qdoc @@ -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 index 0000000000..1783881e1f 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 index 0000000000..7001bfb395 --- /dev/null +++ b/examples/quick/demos/stocqt/doc/src/stocqt.qdoc @@ -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 index 0000000000..930ee39929 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 index 0000000000..9eff191a47 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 index 0000000000..9ba252fcb5 --- /dev/null +++ b/examples/quick/demos/tweetsearch/doc/src/tweetsearch.qdoc @@ -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 +*/ + -- cgit v1.2.3