From 5c88efc06d152ac675b4369d854699b137631fa0 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 8 Aug 2012 12:18:55 +0200 Subject: Examples: Moved example documentation. -inline \example pages into separate .qdoc files -fixed broken links to paths -moved ui-components under examples/quick Change-Id: I6e009b9213be3e1f4bed51bdbeb76a7a2142c80b Reviewed-by: Martin Smith --- examples/quick/threading/doc/src/threading.qdoc | 48 +++++++++++++++++++++++++ examples/quick/threading/threading.qml | 23 ------------ 2 files changed, 48 insertions(+), 23 deletions(-) create mode 100644 examples/quick/threading/doc/src/threading.qdoc (limited to 'examples/quick/threading') diff --git a/examples/quick/threading/doc/src/threading.qdoc b/examples/quick/threading/doc/src/threading.qdoc new file mode 100644 index 0000000000..d645b2bcb4 --- /dev/null +++ b/examples/quick/threading/doc/src/threading.qdoc @@ -0,0 +1,48 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** GNU Free Documentation License +** 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. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms +** and conditions contained in a signed written agreement between you +** and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +/*! + \title QtQuick Examples - Threading + \example quick/threading + \brief This is a collection of QML Multithreading examples. + \image qml-threading-example.png + + Threaded ListModel contains a ListView and a ListModel. The ListModel is updated asynchronusly in another thread, and the results propagate back to the main thread. + A timer requests updates from the worker thread periodically: + \snippet examples/threading/threadedlistmodel/timedisplay.qml 0 + + Inside the worker thread, the ListModel is synchronized once the data is finished loading: + \snippet examples/threading/threadedlistmodel/dataloader.js 0 + + WorkerScript contains an example of using a WorkerScript to offload expensive calculations into another thread. This keeps the UI from being blocked. This example calculates numbers in Pascal's Triangle, and not in a very optimal way, so it will often take several seconds to complete the calculation. By doing this in a WorkerScript in another thread, the UI is not blocked during this time. + + When the UI needs another value, a request is sent to the WorkerScript: + \snippet examples/threading/workerscript/workerscript.qml 0 + The workerscript then is free to take a really long time to calculate it: + \snippet examples/threading/workerscript/workerscript.js 0 + When it's done, the result returns to the main scene via the WorkerScript element: + \snippet examples/threading/workerscript/workerscript.qml 1 +*/ diff --git a/examples/quick/threading/threading.qml b/examples/quick/threading/threading.qml index cff4dd83b9..1b1906734b 100644 --- a/examples/quick/threading/threading.qml +++ b/examples/quick/threading/threading.qml @@ -41,29 +41,6 @@ import QtQuick 2.0 import "../../shared" as Examples -/*! - \title QtQuick Examples - Threading - \example quick/threading - \brief This is a collection of QML Multithreading examples. - \image qml-threading-example.png - - Threaded ListModel contains a ListView and a ListModel. The ListModel is updated asynchronusly in another thread, and the results propagate back to the main thread. - A timer requests updates from the worker thread periodically: - \snippet examples/threading/threadedlistmodel/timedisplay.qml 0 - - Inside the worker thread, the ListModel is synchronized once the data is finished loading: - \snippet examples/threading/threadedlistmodel/dataloader.js 0 - - WorkerScript contains an example of using a WorkerScript to offload expensive calculations into another thread. This keeps the UI from being blocked. This example calculates numbers in Pascal's Triangle, and not in a very optimal way, so it will often take several seconds to complete the calculation. By doing this in a WorkerScript in another thread, the UI is not blocked during this time. - - When the UI needs another value, a request is sent to the WorkerScript: - \snippet examples/threading/workerscript/workerscript.qml 0 - The workerscript then is free to take a really long time to calculate it: - \snippet examples/threading/workerscript/workerscript.js 0 - When it's done, the result returns to the main scene via the WorkerScript element: - \snippet examples/threading/workerscript/workerscript.qml 1 -*/ - Item { height: 480 width: 320 -- cgit v1.2.3