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>
This commit is contained in:
parent
530607d8ba
commit
3e38944118
BIN
examples/dbus/doc/images/dbus-chat-example.png
Normal file
BIN
examples/dbus/doc/images/dbus-chat-example.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 38 KiB |
@ -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
|
** Contact: http://www.qt-project.org/legal
|
||||||
**
|
**
|
||||||
** This file is part of the documentation of the Qt Toolkit.
|
** This file is part of the documentation of the Qt Toolkit.
|
||||||
@ -28,4 +28,14 @@
|
|||||||
/*!
|
/*!
|
||||||
\example chat
|
\example chat
|
||||||
\title D-Bus Chat Example
|
\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
|
||||||
*/
|
*/
|
||||||
|
@ -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
|
** Contact: http://www.qt-project.org/legal
|
||||||
**
|
**
|
||||||
** This file is part of the documentation of the Qt Toolkit.
|
** This file is part of the documentation of the Qt Toolkit.
|
||||||
@ -28,4 +28,16 @@
|
|||||||
/*!
|
/*!
|
||||||
\example complexpingpong
|
\example complexpingpong
|
||||||
\title D-Bus Complex Ping Pong Example
|
\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.
|
||||||
*/
|
*/
|
||||||
|
@ -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
|
** Contact: http://www.qt-project.org/legal
|
||||||
**
|
**
|
||||||
** This file is part of the documentation of the Qt Toolkit.
|
** This file is part of the documentation of the Qt Toolkit.
|
||||||
@ -28,4 +28,12 @@
|
|||||||
/*!
|
/*!
|
||||||
\example listnames
|
\example listnames
|
||||||
\title D-Bus List Names Example
|
\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
|
||||||
*/
|
*/
|
||||||
|
@ -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
|
** Contact: http://www.qt-project.org/legal
|
||||||
**
|
**
|
||||||
** This file is part of the documentation of the Qt Toolkit.
|
** This file is part of the documentation of the Qt Toolkit.
|
||||||
@ -28,4 +28,21 @@
|
|||||||
/*!
|
/*!
|
||||||
\example pingpong
|
\example pingpong
|
||||||
\title D-Bus Ping Pong Example
|
\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
|
||||||
*/
|
*/
|
||||||
|
@ -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
|
** Contact: http://www.qt-project.org/legal
|
||||||
**
|
**
|
||||||
** This file is part of the documentation of the Qt Toolkit.
|
** This file is part of the documentation of the Qt Toolkit.
|
||||||
@ -28,9 +28,13 @@
|
|||||||
/*!
|
/*!
|
||||||
\example remotecontrolledcar
|
\example remotecontrolledcar
|
||||||
\title D-Bus Remote Controlled Car Example
|
\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
|
The Remote Controlled Car example shows how to use \l{Qt D-Bus} to control
|
||||||
application using another.
|
one application from another.
|
||||||
|
|
||||||
\image remotecontrolledcar-car-example.png
|
\image remotecontrolledcar-car-example.png
|
||||||
|
|
||||||
|
\include examples-run.qdocinc
|
||||||
*/
|
*/
|
||||||
|
@ -13,7 +13,8 @@ exampledirs += ../../../examples/dbus \
|
|||||||
snippets
|
snippets
|
||||||
|
|
||||||
headerdirs += ..
|
headerdirs += ..
|
||||||
imagedirs += images
|
imagedirs += images \
|
||||||
|
../../../examples/dbus/doc/images
|
||||||
sourcedirs += .. \
|
sourcedirs += .. \
|
||||||
../../../examples/dbus/doc/src
|
../../../examples/dbus/doc/src
|
||||||
excludedirs += ../../../examples/widgets/doc
|
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.
|
# Only update the name of the project for the next variables.
|
||||||
qhp.QtDBus.virtualFolder = qtdbus
|
qhp.QtDBus.virtualFolder = qtdbus
|
||||||
qhp.QtDBus.subprojects = classes
|
qhp.QtDBus.subprojects = classes examples
|
||||||
qhp.QtDBus.subprojects.classes.title = C++ Classes
|
qhp.QtDBus.subprojects.classes.title = C++ Classes
|
||||||
qhp.QtDBus.subprojects.classes.indexTitle = Qt D-Bus C++ Classes
|
qhp.QtDBus.subprojects.classes.indexTitle = Qt D-Bus C++ Classes
|
||||||
qhp.QtDBus.subprojects.classes.selectors = class fake:headerfile
|
qhp.QtDBus.subprojects.classes.selectors = class fake:headerfile
|
||||||
qhp.QtDBus.subprojects.classes.sortPages = true
|
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.landingpage = "Qt D-Bus"
|
||||||
navigation.cppclassespage = "Qt D-Bus C++ Classes"
|
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" \
|
||||||
|
38
src/dbus/doc/src/qtdbus-examples.qdoc
Normal file
38
src/dbus/doc/src/qtdbus-examples.qdoc
Normal file
@ -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).
|
||||||
|
|
||||||
|
*/
|
@ -211,5 +211,6 @@
|
|||||||
\li \l{The Qt D-Bus Type System}
|
\li \l{The Qt D-Bus Type System}
|
||||||
\li \l{Qt D-Bus XML compiler (qdbusxml2cpp)}
|
\li \l{Qt D-Bus XML compiler (qdbusxml2cpp)}
|
||||||
\li \l{Qt D-Bus C++ Classes}
|
\li \l{Qt D-Bus C++ Classes}
|
||||||
|
\li \l{Qt D-Bus Examples}
|
||||||
\endlist
|
\endlist
|
||||||
*/
|
*/
|
||||||
|
Loading…
Reference in New Issue
Block a user