aboutsummaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorAlan Alpert <alan.alpert@nokia.com>2012-03-20 17:57:07 +1000
committerQt by Nokia <qt-info@nokia.com>2012-03-28 05:49:28 +0200
commit1025b77fe09f010be71ac460475da144e742bf09 (patch)
tree4e3496b305895948c2d16abe6a6f30b363153fa0 /examples
parenta3d4c97c5fb28599e007116fec679b16656df512 (diff)
Tidy up examples documentation
Add missing doc images, move documentation into examples directory, and update example doc references to the new locations (quick/qml instead of declarative or qtquick). Change-Id: I67a9302f2b451b8bf30f4ca6b625f54b240da429 Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
Diffstat (limited to 'examples')
-rw-r--r--examples/demos/calculator/calculator.qdoc4
-rw-r--r--examples/demos/clocks/clocks.qdoc37
-rw-r--r--examples/localstorage/localstorage.qml4
-rw-r--r--examples/qml/dynamicscene/dynamicscene.qml7
-rw-r--r--examples/qml/i18n/i18n.qml40
-rw-r--r--examples/quick/accessibility/accessibility.qml2
-rw-r--r--examples/quick/animation/animation.qml2
-rw-r--r--examples/quick/canvas/canvas.qml1
-rw-r--r--examples/quick/draganddrop/draganddrop.qml2
-rw-r--r--examples/quick/imageelements/imageelements.qml2
-rw-r--r--examples/quick/positioners/positioners-transitions.qml4
-rw-r--r--examples/quick/righttoleft/righttoleft.qml2
-rw-r--r--examples/quick/shadereffects/shadereffects.qml2
-rw-r--r--examples/quick/text/text.qml2
-rw-r--r--examples/quick/threading/threading.qml2
-rw-r--r--examples/quick/touchinteraction/touchinteraction.qml2
16 files changed, 83 insertions, 32 deletions
diff --git a/examples/demos/calculator/calculator.qdoc b/examples/demos/calculator/calculator.qdoc
index e94bdb4cfd..793948703e 100644
--- a/examples/demos/calculator/calculator.qdoc
+++ b/examples/demos/calculator/calculator.qdoc
@@ -27,9 +27,9 @@
/*!
\title QML Demo - Calculator
- \example declarative/calculator
+ \example demos/calculator
\brief This is an example calculator application written in QML.
- \image qml-calculator-demo-small.png
+ \image qml-calculator-example-small.png
The Calculator demo implements a simple calculator in QML. It is written for desktop and portrait devices,
although on device it supports orientation changes.
diff --git a/examples/demos/clocks/clocks.qdoc b/examples/demos/clocks/clocks.qdoc
new file mode 100644
index 0000000000..54479bae17
--- /dev/null
+++ b/examples/demos/clocks/clocks.qdoc
@@ -0,0 +1,37 @@
+/****************************************************************************
+**
+** 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 QML Demo - Clocks
+ \example demos/clocks
+ \brief This example demonstrates creating components and using them multiple times.
+ \image qml-clocks-example.png
+
+ This demo give a simple world clock application, containing multiple clocks from around the world.
+
+ In doing this, it reuses a signle Clock component with some slight changes to the parameters.
+*/
diff --git a/examples/localstorage/localstorage.qml b/examples/localstorage/localstorage.qml
index f967518de8..714774c78e 100644
--- a/examples/localstorage/localstorage.qml
+++ b/examples/localstorage/localstorage.qml
@@ -43,7 +43,7 @@ import "../shared" as Examples
/*!
\title QtQuick Examples - Local Storage
- \example qtquick/localstorage
+ \example localstorage
\brief This is a collection of QML local storage examples
\image qml-localstorage-example.png
@@ -63,4 +63,4 @@ Item {
addExample("Hello World", "Simple SQL operations with local storage API", Qt.resolvedUrl("hello.qml"));
}
}
-} \ No newline at end of file
+}
diff --git a/examples/qml/dynamicscene/dynamicscene.qml b/examples/qml/dynamicscene/dynamicscene.qml
index 66521b8caa..4771742621 100644
--- a/examples/qml/dynamicscene/dynamicscene.qml
+++ b/examples/qml/dynamicscene/dynamicscene.qml
@@ -38,6 +38,13 @@
**
****************************************************************************/
+/*!
+ \title QML Example - Dynamic Scene
+ \example qml/dynamicscene
+ \brief This example demonstrates creating components dynamically.
+ \image qml-dynamicscene-example.png
+*/
+
import QtQuick 2.0
import QtQuick.Particles 2.0
import "content"
diff --git a/examples/qml/i18n/i18n.qml b/examples/qml/i18n/i18n.qml
index f8bf30d0f0..2ffdd1914f 100644
--- a/examples/qml/i18n/i18n.qml
+++ b/examples/qml/i18n/i18n.qml
@@ -40,23 +40,29 @@
import QtQuick 2.0
-//
-// The QML runtime automatically loads a translation from the i18n subdirectory of the root
-// QML file, based on the system language.
-//
-// The files are created/updated by running:
-//
-// lupdate i18n.qml -ts i18n/base.ts
-//
-// Translations for new languages are created by copying i18n/base.ts to i18n/qml_<lang>.ts
-// The .ts files can then be edited with Linguist:
-//
-// linguist i18n/qml_fr.ts
-//
-// The run-time translation files are then generated by running:
-//
-// lrelease i18n/*.ts
-//
+/*!
+ \title QML Examples - Internationalization
+ \example qml/i18n
+ \image qml-i18n-example.png
+ \brief This is an internationalization example
+
+ The QML runtime automatically loads a translation from the i18n subdirectory of the root
+ QML file, based on the system language.
+
+ The files are created/updated by running:
+
+ lupdate i18n.qml -ts i18n/base.ts
+
+ Translations for new languages are created by copying i18n/base.ts to i18n/qml_<lang>.ts
+ The .ts files can then be edited with Linguist:
+
+ linguist i18n/qml_fr.ts
+
+ The run-time translation files are then generated by running:
+
+ lrelease i18n/*.ts
+*/
+
Rectangle {
width: 640; height: 480
diff --git a/examples/quick/accessibility/accessibility.qml b/examples/quick/accessibility/accessibility.qml
index e987561bb1..5e4b0f8dcd 100644
--- a/examples/quick/accessibility/accessibility.qml
+++ b/examples/quick/accessibility/accessibility.qml
@@ -44,7 +44,7 @@ import "content"
/*!
\title QtQuick Examples - Accessibility
- \example qtquick/accessibility
+ \example quick/accessibility
\brief This example has accessible buttons.
*/
diff --git a/examples/quick/animation/animation.qml b/examples/quick/animation/animation.qml
index bca68457d9..f478cb713b 100644
--- a/examples/quick/animation/animation.qml
+++ b/examples/quick/animation/animation.qml
@@ -43,7 +43,7 @@ import "../../shared" as Examples
/*!
\title QtQuick Examples - Animation
- \example qtquick/animation
+ \example quick/animation
\brief This is a collection of QML Animation examples.
\image qml-animations-example.png
diff --git a/examples/quick/canvas/canvas.qml b/examples/quick/canvas/canvas.qml
index bdb58f4c78..cf3c37a4c3 100644
--- a/examples/quick/canvas/canvas.qml
+++ b/examples/quick/canvas/canvas.qml
@@ -45,6 +45,7 @@ import "../../shared" as Examples
\title QtQuick Examples - Canvas
\example quick/canvas
\brief This is a collection of QML Canvas examples.
+ \image qml-canvas-example.png
This is a collection of small QML examples relating to Canvas item. Each example is
a small QML file emphasizing a particular element or feature.
diff --git a/examples/quick/draganddrop/draganddrop.qml b/examples/quick/draganddrop/draganddrop.qml
index 88e6d5e021..9f56177f23 100644
--- a/examples/quick/draganddrop/draganddrop.qml
+++ b/examples/quick/draganddrop/draganddrop.qml
@@ -43,7 +43,7 @@ import "../../shared" as Examples
/*!
\title QtQuick Examples - Drag and Drop
- \example qtquick/draganddrop
+ \example quick/draganddrop
\brief This is a collection of QML drag and drop examples
\image qml-draganddrop-example.png
diff --git a/examples/quick/imageelements/imageelements.qml b/examples/quick/imageelements/imageelements.qml
index bb23ef6979..adfa43a659 100644
--- a/examples/quick/imageelements/imageelements.qml
+++ b/examples/quick/imageelements/imageelements.qml
@@ -43,7 +43,7 @@ import "../../shared"
/*!
\title QML Examples - Image Elements
- \example declarative/imageelements
+ \example quick/imageelements
\brief This is a collection of QML examples
\image qml-imageelements-example.png
diff --git a/examples/quick/positioners/positioners-transitions.qml b/examples/quick/positioners/positioners-transitions.qml
index 6081c9f8a8..f1b61c1740 100644
--- a/examples/quick/positioners/positioners-transitions.qml
+++ b/examples/quick/positioners/positioners-transitions.qml
@@ -43,12 +43,12 @@ import QtQuick 2.0
Rectangle {
id: page
width: 320; height: 480
- property int effectiveOpacity: 1.0
+ property real effectiveOpacity: 1.0
Timer {
interval: 2000
running: true
repeat: true
- onTriggered: effectiveOpacity = (effectiveOpacity == 1.0 ? 0.0 : 1.0)
+ onTriggered: effectiveOpacity = (effectiveOpacity == 1.0 ? 0.0 : 1.0);
}
Column {
diff --git a/examples/quick/righttoleft/righttoleft.qml b/examples/quick/righttoleft/righttoleft.qml
index 6561595603..b95f671d95 100644
--- a/examples/quick/righttoleft/righttoleft.qml
+++ b/examples/quick/righttoleft/righttoleft.qml
@@ -43,7 +43,7 @@ import "../../shared" as Examples
/*!
\title QtQuick Examples - Right to Left
- \example qtquick/Right to Left
+ \example quick/righttoleft
\brief This is a collection of QML Right to Left examples.
\image qml-righttoleft-example.png
diff --git a/examples/quick/shadereffects/shadereffects.qml b/examples/quick/shadereffects/shadereffects.qml
index 25efa5f4ed..4b3bb2a5e2 100644
--- a/examples/quick/shadereffects/shadereffects.qml
+++ b/examples/quick/shadereffects/shadereffects.qml
@@ -48,7 +48,7 @@ Rectangle {
height: 480
/*!
\title QML Examples - Shader Effects
- \example declarative/shadereffects
+ \example quick/shadereffects
\image qml-shadereffects-example.png
\brief This is a shader effects example
diff --git a/examples/quick/text/text.qml b/examples/quick/text/text.qml
index e9c40773c9..e8be93cb69 100644
--- a/examples/quick/text/text.qml
+++ b/examples/quick/text/text.qml
@@ -42,7 +42,7 @@ import QtQuick 2.0
import "../../shared"
/*!
\title QML Examples - Text
- \example declarative/text
+ \example quick/text
\brief This is a collection of QML examples
\image qml-text-example.png
diff --git a/examples/quick/threading/threading.qml b/examples/quick/threading/threading.qml
index 7ba8b8f70d..b96c6975ac 100644
--- a/examples/quick/threading/threading.qml
+++ b/examples/quick/threading/threading.qml
@@ -43,7 +43,7 @@ import "../../shared" as Examples
/*!
\title QtQuick Examples - Threading
- \example qtquick/threading
+ \example quick/threading
\brief This is a collection of QML Multithreading examples.
\image qml-threading-example.png
diff --git a/examples/quick/touchinteraction/touchinteraction.qml b/examples/quick/touchinteraction/touchinteraction.qml
index 0be625a160..e64c145714 100644
--- a/examples/quick/touchinteraction/touchinteraction.qml
+++ b/examples/quick/touchinteraction/touchinteraction.qml
@@ -43,7 +43,7 @@ import "../../shared"
/*!
\title QtQuick Examples - Touch Interaction
- \example qtquick/touchinteraction
+ \example quick/touchinteraction
\brief This is a collection of QML Touch Interaction examples.
\image qml-touchinteraction-example.png