summaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorKarsten Heimrich <karsten.heimrich@qt.io>2019-04-17 12:35:04 +0200
committerKarsten Heimrich <karsten.heimrich@qt.io>2019-04-17 12:04:09 +0000
commita71668d658594b574860810e2ba8ff9f955a0f05 (patch)
tree876c4813a2992333c41bff2d97ca3be20e8cd48b /examples
parent4fa83385725eb2a433c033be1ad9065ecb8de34e (diff)
Doc: Fix example code generation
Change-Id: If8b397308a8607368fcd3bdff782ab9fecc4071b Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'examples')
-rw-r--r--examples/knx/doc/group.qdoc27
1 files changed, 8 insertions, 19 deletions
diff --git a/examples/knx/doc/group.qdoc b/examples/knx/doc/group.qdoc
index d82d517..9d9dd15 100644
--- a/examples/knx/doc/group.qdoc
+++ b/examples/knx/doc/group.qdoc
@@ -84,7 +84,8 @@
There are signal handlers installed for every signal emitted by the
\l QKnxNetIpTunnel. Here is an example of the setup capturing the
signals emitted when an event occurs targeting the KNXnet/IP connection.
- In this specific example, we will see how to set up the KNXnet/IP tunnel:
+ In this specific example, we will also see how to set up the KNXnet/IP
+ tunnel and connect to the KNXnet/IP device:
\quotefromfile group/mainwindow.cpp
\skipto MainWindow::MainWindow
@@ -110,31 +111,19 @@
\printuntil /^\}/
There is a signal handler installed for the device discovered signal
- emitted by the discovery agent. Here is the example of the setup capturing
- the \l QKnxNetIpServerDiscoveryAgent::deviceDiscovered signal emitted when
- a KNXnet/IP device is found:
-
- \quotefromfile group/mainwindow.cpp
- \skipto MainWindow::MainWindow
- \printuntil {
- \dots
- \skipto QKnxNetIpServerDiscoveryAgent::deviceDiscovered
- \printuntil );
- \dots
-
+ emitted by the discovery agent.
When the signal \l QKnxNetIpServerDiscoveryAgent::deviceDiscovered is
triggered, the function \c MainWindow::onDeviceDiscovered() is called.
It adds a new device item to the \uicontrol {Device} if it is not already
there.
- At this point, users can select one of the available devices to establish
- a connection, and send the different types of frames or simply monitor the
- KNX bus traffic:
-
- \quotefromfile group/mainwindow.cpp
- \skipto MainWindow::onDeviceDiscovered
+ \quotefromfile device/mainwindow.cpp
+ \skipto void MainWindow::onDeviceDiscovered
\printuntil /^\}/
+ At this point, users can select one of the available devices to establish
+ a connection, create and send the different types of frames or simply
+ monitor the KNX bus traffic.
The \c MainWindow::on_devices_currentIndexChanged method saves the selected
KNXnet/IP device in the the \c MainWindow instance.