summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Wicking <paul.wicking@qt.io>2018-06-28 15:04:35 +0200
committerPaul Wicking <paul.wicking@qt.io>2018-06-29 05:16:04 +0000
commit7f7ceb567fe2f58b47b66415f30918f3b482f2b0 (patch)
treee42aa4642a77c8ea6ae3110e8ce3216cdf76a19e
parente5b3db841d9912cfc1a8252f5e6f687006a5ea2b (diff)
Doc: Add references to QDBusAbstractAdaptor implementation example
Adding references where applicable, as removed by 023a818738d64da01ebecc5d4a26356055ba0021 when removing stale example. Add example run snippet to the example landing page. Remove stale example qdoc file that is superceded by current example. Task-number: QTBUG-69191 Change-Id: I62dc66edc86da5efb4c79fd124edb2fa619aeb6b Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
-rw-r--r--doc/src/examples/complexpingpong.qdoc36
-rw-r--r--examples/dbus/doc/src/complexpingpong.qdoc8
-rw-r--r--src/dbus/doc/src/dbus-adaptors.qdoc8
3 files changed, 14 insertions, 38 deletions
diff --git a/doc/src/examples/complexpingpong.qdoc b/doc/src/examples/complexpingpong.qdoc
deleted file mode 100644
index 4a7cec21bb..0000000000
--- a/doc/src/examples/complexpingpong.qdoc
+++ /dev/null
@@ -1,36 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2016 The Qt Company Ltd.
-** Contact: https://www.qt.io/licensing/
-**
-** 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 The Qt Company. For licensing terms
-** and conditions see https://www.qt.io/terms-conditions. For further
-** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
- \example complexpingpong
- \title Complex Ping Pong Example
-
- The Complex Ping Pong example improves on the \l{D-Bus Ping Pong Example} by providing
- a more useful demonstration of D-Bus interfaces.
-
- \quotefile doc/src/snippets/complexpingpong-example.txt
-*/
diff --git a/examples/dbus/doc/src/complexpingpong.qdoc b/examples/dbus/doc/src/complexpingpong.qdoc
index fca654a06a..d09708c0ff 100644
--- a/examples/dbus/doc/src/complexpingpong.qdoc
+++ b/examples/dbus/doc/src/complexpingpong.qdoc
@@ -40,4 +40,12 @@
\include examples-run.qdocinc
To run, execute the \c complexping application.
+
+ \badcode
+ $ ./complexping
+ Ask your question: When is the next Qt release?
+ Reply was: Sorry, I don't know the answer
+ Ask your question: What is the answer to life, the universe and everything?
+ Reply was: 42
+ \endcode
*/
diff --git a/src/dbus/doc/src/dbus-adaptors.qdoc b/src/dbus/doc/src/dbus-adaptors.qdoc
index fe9d57f1d1..9ebf0cedf2 100644
--- a/src/dbus/doc/src/dbus-adaptors.qdoc
+++ b/src/dbus/doc/src/dbus-adaptors.qdoc
@@ -68,6 +68,8 @@
\li \l{Declaring Slots in D-Bus Adaptors}
\li \l{Declaring Signals in D-Bus Adaptors}
\li \l{The Qt D-Bus Type System}
+ \li In the \l{D-Bus Complex Ping Pong Example}, \c complexpong.h and
+ \c complexpong.cpp show an implementation of QDBusAbstractAdaptor.
\endlist
\sa QDBusAbstractAdaptor
@@ -109,7 +111,8 @@
synchronize with the caller should provide its own method of synchronization.
Asynchronous slots are marked by the keyword \l Q_NOREPLY in the method
- signature, before the \c void return type and the slot name.
+ signature, before the \c void return type and the slot name. The \c quit()
+ slot in the \l {D-Bus Complex Ping Pong Example} is an example of this.
\section1 Input-Only Slots
@@ -219,7 +222,8 @@
However, signals must still be emitted. The easiest way to emit an adaptor
signal is to connect another signal to it, so that Qt's signals and slots
mechanism automatically emits the adaptor signal, too. This can be done in
- the adaptor's constructor.
+ the adaptor's constructor, as you can see in the \l {D-Bus Complex Ping
+ Pong Example}.
The QDBusAbstractAdaptor::setAutoRelaySignals() convenience function can also
be used to make and break connections between signals in the real object and