From 1025b77fe09f010be71ac460475da144e742bf09 Mon Sep 17 00:00:00 2001
From: Alan Alpert <alan.alpert@nokia.com>
Date: Tue, 20 Mar 2012 17:57:07 +1000
Subject: 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>
---
 examples/qml/dynamicscene/dynamicscene.qml |  7 ++++++
 examples/qml/i18n/i18n.qml                 | 40 +++++++++++++++++-------------
 2 files changed, 30 insertions(+), 17 deletions(-)

(limited to 'examples/qml')

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
-- 
cgit v1.2.3