summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2014-05-23 17:35:10 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-05-28 16:52:04 +0200
commit3e38944118a0195620a6c4bff591155cdd560b63 (patch)
tree8927cd1813db7a4f6a9effaf6463634c9ea2aa1c /examples
parent530607d8ba0dac8d91d20ec0e62d3129cb21e225 (diff)
downloadqtbase-3e38944118a0195620a6c4bff591155cdd560b63.tar.gz
qtbase-3e38944118a0195620a6c4bff591155cdd560b63.tar.bz2
qtbase-3e38944118a0195620a6c4bff591155cdd560b63.zip
doc: Updated Qt D-Bus Examples.
-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>
Diffstat (limited to 'examples')
-rw-r--r--examples/dbus/doc/images/dbus-chat-example.pngbin0 -> 38530 bytes
-rw-r--r--examples/dbus/doc/src/chat.qdoc12
-rw-r--r--examples/dbus/doc/src/complexpingpong.qdoc14
-rw-r--r--examples/dbus/doc/src/listnames.qdoc10
-rw-r--r--examples/dbus/doc/src/pingpong.qdoc19
-rw-r--r--examples/dbus/remotecontrolledcar/doc/src/dbus-remotecontrolledcar.qdoc10
6 files changed, 58 insertions, 7 deletions
diff --git a/examples/dbus/doc/images/dbus-chat-example.png b/examples/dbus/doc/images/dbus-chat-example.png
new file mode 100644
index 0000000000..ad66d08950
--- /dev/null
+++ b/examples/dbus/doc/images/dbus-chat-example.png
Binary files differ
diff --git a/examples/dbus/doc/src/chat.qdoc b/examples/dbus/doc/src/chat.qdoc
index 45b1260140..daf3eccc9a 100644
--- a/examples/dbus/doc/src/chat.qdoc
+++ b/examples/dbus/doc/src/chat.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** 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.
@@ -28,4 +28,14 @@
/*!
\example chat
\title D-Bus Chat Example
+ \ingroup examples-dbus
+ \brief Demonstrates communication among instances of an application.
+
+ \e Chat is a \l{Qt D-Bus} example which demonstrates a simple chat system
+ among instances of an application. Users connect and send message to
+ each other.
+
+ \image dbus-chat-example.png
+
+ \include examples-run.qdocinc
*/
diff --git a/examples/dbus/doc/src/complexpingpong.qdoc b/examples/dbus/doc/src/complexpingpong.qdoc
index b4cac193fc..ef9df18eab 100644
--- a/examples/dbus/doc/src/complexpingpong.qdoc
+++ b/examples/dbus/doc/src/complexpingpong.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** 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.
@@ -28,4 +28,16 @@
/*!
\example complexpingpong
\title D-Bus Complex Ping Pong Example
+ \ingroup examples-dbus
+ \brief Demonstrates usage of the Qt D-Bus typesystem.
+
+ \e{Complex Ping Pong Example} demonstrates the use of \l{Qt D-Bus}
+ typesystem with QDBusVariant and QDBusReply. The example consists of the
+ main application \c complexping which starts the other application, \c
+ complexpong. Entering keywords such as \c hello and \c ping is handled by
+ complexpong and the reply is printed to the standard output.
+
+ \include examples-run.qdocinc
+
+ To run, execute the \c complexping application.
*/
diff --git a/examples/dbus/doc/src/listnames.qdoc b/examples/dbus/doc/src/listnames.qdoc
index 5e17db9674..a0376e10a7 100644
--- a/examples/dbus/doc/src/listnames.qdoc
+++ b/examples/dbus/doc/src/listnames.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** 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.
@@ -28,4 +28,12 @@
/*!
\example listnames
\title D-Bus List Names Example
+ \ingroup examples-dbus
+ \brief Shows how to access the D-Bus bus daemon service.
+
+ \e{List Names} is a command-line example which shows how to
+ access the \l{Qt D-Bus} bus daemon service. The example prints various
+ information about the bus daemon service.
+
+ \include examples-run.qdocinc
*/
diff --git a/examples/dbus/doc/src/pingpong.qdoc b/examples/dbus/doc/src/pingpong.qdoc
index c7dc110077..dcaeb12043 100644
--- a/examples/dbus/doc/src/pingpong.qdoc
+++ b/examples/dbus/doc/src/pingpong.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** 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.
@@ -28,4 +28,21 @@
/*!
\example pingpong
\title D-Bus Ping Pong Example
+ \ingroup examples-dbus
+ \brief Demonstrates a simple message system using D-Bus.
+
+ \e{Ping Pong} is a command-line example that demonstrates the basics of
+ \l{Qt D-Bus}. A message is sent to another application and there is a
+ confirmation of the message.
+
+ \include examples-run.qdocinc
+
+ Run the \c pong application and run the \c ping application with the message
+ as the argument.
+
+ \badcode
+ $ ./pong &
+ $ ./ping Hello
+ Reply was: ping("Hello") got called
+ \endcode
*/
diff --git a/examples/dbus/remotecontrolledcar/doc/src/dbus-remotecontrolledcar.qdoc b/examples/dbus/remotecontrolledcar/doc/src/dbus-remotecontrolledcar.qdoc
index 522b0bacc7..a485a99299 100644
--- a/examples/dbus/remotecontrolledcar/doc/src/dbus-remotecontrolledcar.qdoc
+++ b/examples/dbus/remotecontrolledcar/doc/src/dbus-remotecontrolledcar.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** 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.
@@ -28,9 +28,13 @@
/*!
\example remotecontrolledcar
\title D-Bus Remote Controlled Car Example
+ \ingroup examples-dbus
+ \brief Shows how to use Qt D-Bus to control a car from another application.
- The Remote Controlled Car example shows how to use D-Bus to control one
- application using another.
+ The Remote Controlled Car example shows how to use \l{Qt D-Bus} to control
+ one application from another.
\image remotecontrolledcar-car-example.png
+
+ \include examples-run.qdocinc
*/