aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKavindra Palaraja <kpalaraja@luxoft.com>2019-09-03 09:49:22 +0200
committerKavindra Palaraja <kpalaraja@luxoft.com>2019-09-06 14:30:56 +0200
commit652b913691985979a3c4f90483bab880603f8303 (patch)
treeb9648f71f5d846f5224370f8828dadb79e95a591
parentcba0a991d28398b9681f7aae183bdcc54757c4cb (diff)
[docs] Add chapter headings to improve navigability
Change-Id: Ia0e72321c6252b15149d23cbd9c0ceacc67fd775 Reviewed-by: Dominik Holland <dominik.holland@pelagicore.com>
-rw-r--r--src/ivicore/doc/src/examples-qface-tutorial.qdoc30
1 files changed, 18 insertions, 12 deletions
diff --git a/src/ivicore/doc/src/examples-qface-tutorial.qdoc b/src/ivicore/doc/src/examples-qface-tutorial.qdoc
index 0c790d4..4fe5726 100644
--- a/src/ivicore/doc/src/examples-qface-tutorial.qdoc
+++ b/src/ivicore/doc/src/examples-qface-tutorial.qdoc
@@ -37,12 +37,12 @@
following steps:
\list 1
- \li Integrate a basic interface integration without a backend
- \li Extend the interface and add annotations
- \li Add a simulation backend and corresponding simulation annotations; with a QML plugin
- \li Add a custom simulation behavior
- \li Add a simulation server and use it from a Qt Remote Objects Backend
- \li Develop a production backend that connects to a DBus interface
+ \li \l{chapter1}{Integrate a basic interface without a backend}
+ \li \l{chapter2}{Extend the interface and add annotations}
+ \li \l{chapter3}{Add a simulation backend and corresponding simulation annotations; with a QML plugin}
+ \li \l{chapter4}{Add a custom simulation behavior}
+ \li \l{chapter5}{Add a simulation server and use it from a Qt Remote Objects Backend}
+ \li \l{chapter6}{Develop a production backend that connects to a DBus interface}
\endlist
Before we start the actual Middleware integration, let's take a look at the existing Instrument
@@ -76,7 +76,8 @@
\image examples_qface_tutorial_final.gif
- \section1 Basic Middlware API with the help of the IVI Generator
+ \target chapter1
+ \section1 Chapter 1: Basic Middlware API with the IVI Generator
In this chapter we integrate a Middleware API into the existing Instrument Cluster QML code.
Instead of manually writing all of these parts ourselves, which is done in most basic
@@ -191,7 +192,8 @@
\printuntil }
- \section1 Chapter 2
+ \target chapter2
+ \section1 Chapter 2: Extend the Interface and add Annotations
In this chapter we extend our Middleware API with more properties via enums and by defining our
own structure.
@@ -294,7 +296,8 @@
\printuntil }
- \section1 Chapter 3
+ \target chapter3
+ \section1 Chapter 3: Add a Simulation Backend and Annotations with a QML plugin
In the previous two chapters, we wrote a Middleware API using a QFace file and used the IVI
Generator to autogenerate a C++ API in the form of a library. Now, in this chapter, we extend
@@ -433,7 +436,8 @@
What has changed is that we've now added an additional import path with the \c addImportPath
function, which points to the "imports" folder next to the binary's location.
- \section1 Chapter 4
+ \target chapter4
+ \section1 Chapter 4: Add a Custom Simulation
So far, we've created a Middleware API and integrated it into our Instrument Cluster QML code,
extended it with a QML plugin, and generated a simulation backend. In the background, quite a
@@ -572,7 +576,8 @@
Now, rebuilding the simulation backend embeds the simulation file into the plugin and hands the
file over to the QIviSimulationEngine, which starts the simulation when loaded.
- \section1 Chapter 5
+ \target chapter5
+ \section1 Chapter 5: Add a Simulation Server Combined with QtRemoteObjects
In this chapter we extend our Instrument Cluster to use an Inter-Process Communication (IPC)
mechanism and use two processes. At the moment, the simulation is loaded as a plugin that
@@ -639,7 +644,8 @@
\image examples_qface_tutorial_sync.gif
- \section1 Chapter 6
+ \target chapter6
+ \section1 Chapter 6: Develop a Production Backend with D-Bus
Previously, we extended our Instrument Cluster code by using QtRemoteObjects as IPC and
autogenerated a backend for it, as well as a server that provides the simulation. In this