From 3e38944118a0195620a6c4bff591155cdd560b63 Mon Sep 17 00:00:00 2001
From: Jerome Pasion <jerome.pasion@digia.com>
Date: Fri, 23 May 2014 17:35:10 +0200
Subject: doc: Updated Qt D-Bus Examples.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

-transferred group page from qtdoc repository
-added description in example pages
-set the example documentation to use the standard Qt thumbnail
-added an entry in the help index for the example page

Change-Id: I9d5747bc329b5ecc15acd2eb3139696931166c6f
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
---
 src/dbus/doc/qtdbus.qdocconf          | 12 +++++++++--
 src/dbus/doc/src/qtdbus-examples.qdoc | 38 +++++++++++++++++++++++++++++++++++
 src/dbus/doc/src/qtdbus-index.qdoc    |  1 +
 3 files changed, 49 insertions(+), 2 deletions(-)
 create mode 100644 src/dbus/doc/src/qtdbus-examples.qdoc

(limited to 'src/dbus')

diff --git a/src/dbus/doc/qtdbus.qdocconf b/src/dbus/doc/qtdbus.qdocconf
index 1233ae3d47..ff46cc5961 100644
--- a/src/dbus/doc/qtdbus.qdocconf
+++ b/src/dbus/doc/qtdbus.qdocconf
@@ -13,7 +13,8 @@ exampledirs += ../../../examples/dbus \
                snippets
 
 headerdirs += ..
-imagedirs += images
+imagedirs += images \
+             ../../../examples/dbus/doc/images
 sourcedirs += .. \
               ../../../examples/dbus/doc/src
 excludedirs += ../../../examples/widgets/doc
@@ -44,11 +45,18 @@ qhp.QtDBus.indexTitle = Qt D-Bus
 
 # Only update the name of the project for the next variables.
 qhp.QtDBus.virtualFolder  = qtdbus
-qhp.QtDBus.subprojects = classes
+qhp.QtDBus.subprojects = classes examples
 qhp.QtDBus.subprojects.classes.title = C++ Classes
 qhp.QtDBus.subprojects.classes.indexTitle = Qt D-Bus C++ Classes
 qhp.QtDBus.subprojects.classes.selectors = class fake:headerfile
 qhp.QtDBus.subprojects.classes.sortPages = true
+qhp.QtDBus.subprojects.examples.title = Examples
+qhp.QtDBus.subprojects.examples.indexTitle = Qt D-Bus Examples
+qhp.QtDBus.subprojects.examples.selectors = fake:example
 
 navigation.landingpage = "Qt D-Bus"
 navigation.cppclassespage = "Qt D-Bus C++ Classes"
+
+manifestmeta.thumbnail.names    =   "QtDBus/D-Bus List Names Example" \
+                                    "QtDBus/D-Bus Ping Pong Example" \
+                                    "QtDBus/D-Bus Complex Ping Pong Example" \
diff --git a/src/dbus/doc/src/qtdbus-examples.qdoc b/src/dbus/doc/src/qtdbus-examples.qdoc
new file mode 100644
index 0000000000..c0dde656b6
--- /dev/null
+++ b/src/dbus/doc/src/qtdbus-examples.qdoc
@@ -0,0 +1,38 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 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$
+**
+****************************************************************************/
+
+/*!
+    \group examples-dbus
+    \title Qt D-Bus Examples
+    \brief Using D-Bus from Qt applications.
+    \ingroup all-examples
+
+    \l{Qt D-Bus} allows applications to send messages to each other using
+    D-Bus. This page lists examples which specifically use D-Bus for
+    inter-process communication (IPC).
+
+*/
diff --git a/src/dbus/doc/src/qtdbus-index.qdoc b/src/dbus/doc/src/qtdbus-index.qdoc
index b7c2ddbc92..2249924ada 100644
--- a/src/dbus/doc/src/qtdbus-index.qdoc
+++ b/src/dbus/doc/src/qtdbus-index.qdoc
@@ -211,5 +211,6 @@
     \li \l{The Qt D-Bus Type System}
     \li \l{Qt D-Bus XML compiler (qdbusxml2cpp)}
     \li \l{Qt D-Bus C++ Classes}
+    \li \l{Qt D-Bus Examples}
     \endlist
 */
-- 
cgit v1.2.3