doc: Various doc fixes

* Added a link to the Generator Tutorial to the front page
* Added a short paragraph about RPATH linking to the tutorial
* Fixed linking warnings

Change-Id: I085ddbe5c0e9939e2e22ae7188c307fae52f77b2
Reviewed-by: Robert Griebl <robert.griebl@qt.io>

10 files changed, 30 insertions, 15 deletions

diff --git a/examples/ivicore/qface-tutorial/chapter5-ipc/simulation_server/simulation_server.pro b/examples/ivicore/qface-tutorial/chapter5-ipc/simulation_server/simulation_server.pro
index a80c220..48c0164 100644
--- a/examples/ivicore/qface-tutorial/chapter5-ipc/simulation_server/simulation_server.pro
+++ b/examples/ivicore/qface-tutorial/chapter5-ipc/simulation_server/simulation_server.pro
@@ -12,9 +12,9 @@ INCLUDEPATH += $$OUT_PWD/../frontend
 QFACE_FORMAT = server_qtro_simulator
 QFACE_SOURCES = ../instrument-cluster.qface
 
-RESOURCES += ../backend_simulator/simulation.qrc
-
 QML_IMPORT_PATH = $$OUT_PWD/qml
 
+RESOURCES += ../backend_simulator/simulation.qrc
+
 target.path = $$[QT_INSTALL_EXAMPLES]/ivicore/qface-tutorial/chapter5-ipc/simulation_server
 INSTALLS += target
diff --git a/src/ivicore/doc/src/concepts.qdoc b/src/ivicore/doc/src/concepts.qdoc
index d34905a..cb23917 100644
--- a/src/ivicore/doc/src/concepts.qdoc
+++ b/src/ivicore/doc/src/concepts.qdoc
@@ -33,7 +33,7 @@ All Qt IVI feature APIs depend on the following set of key concepts:
 
 \list
     \li \l {Dynamic Backend System}
-    \li \l {Qt IVI Autogenerator}
+    \li \l {Qt IVI Generator}
     \li \l {Models}
     \li \l {Qt IVI Query Language}
     \li \l {Qt IVI Simulation System}
diff --git a/src/ivicore/doc/src/examples-qface-tutorial.qdoc b/src/ivicore/doc/src/examples-qface-tutorial.qdoc
index d5941a5..394fef2 100644
--- a/src/ivicore/doc/src/examples-qface-tutorial.qdoc
+++ b/src/ivicore/doc/src/examples-qface-tutorial.qdoc
@@ -115,7 +115,7 @@
     \section2 Autogeneration
 
     Now that our first version of the IDL file is ready, it's time to autogenerate API from it,
-    using the \l{Qt IVI Autogenerator}{IVI Generator tool}. Similar to
+    using the \l{Qt IVI Generator}{IVI Generator tool}. Similar to
     \l{https://doc.qt.io/qt-5/moc.html}{moc}, this autogeneration process is integrated into the
     qmake Build System and is done on compile time.
 
@@ -393,6 +393,19 @@
     function or using the \c QT_PLUGIN_PATH environment variable. For more information, see
     \l{https://doc.qt.io/qt-5/plugins-howto.html}{How to create Qt Plugins}.
 
+    Now everything is in place, but because our plugin links against the frontend library, we need
+    to make sure the library can be found by the dynamic linker. This can be achieved by
+    setting the \c LD_LIBRARY_PATH environment variable to our library folder. But this results
+    in the problem, that every user would need to set this variable to be able to use our
+    application.
+    To make things easier for the user, we rather use a relative RPATH instead and annotate our
+    plugin with the information for the linker, where it might find the needed libraries, relative
+    to the plugin's location:
+
+    \quotefromfile ivicore/qface-tutorial/chapter3-simulation-backend/backend_simulator/backend_simulator.pro
+    \skipto INCLUDEPATH
+    \printuntil QMAKE_RPATHDIR
+
     \section2 Export the QML Types in a QML Plugin
 
     In the first chapter, we extended our \c main.cpp to register all types of our autogenerated
@@ -612,7 +625,7 @@
     part can also be autogenerated using the IVI Generator in a similar fashion:
 
     \quotefromfile ivicore/qface-tutorial/chapter5-ipc/simulation_server/simulation_server.pro
-    \printto target.path
+    \printto RESOURCES
 
     Because we'd like to generate a server binary, the \c TEMPLATE needs to be set to "app" instead
     of "lib". Similar to the plugin, the server also needs to link against our library to give it
@@ -704,7 +717,7 @@
 
     \quotefromfile ivicore/qface-tutorial/chapter6-own-backend/backend_dbus/instrumentclusterplugin.cpp
     \skipto #include
-    \printuntil eof
+    \printto
 
     In \c interfaces() we use the IID which is defined in \c{instrumentclusterbackendinterface.h}
     from our autogenerated library. In \c insterfaceInstance() we check for the correct string and
diff --git a/src/ivicore/doc/src/ivigenerator/ivigenerator.qdoc b/src/ivicore/doc/src/ivigenerator/ivigenerator.qdoc
index 2d62ed5..2e1f43a 100644
--- a/src/ivicore/doc/src/ivigenerator/ivigenerator.qdoc
+++ b/src/ivicore/doc/src/ivigenerator/ivigenerator.qdoc
@@ -53,6 +53,7 @@ Currently, Qt IVI generator has the following limitations:
     \li It's not possible to import other QFace modules using the \c import command.
     \li There's no support for external C++ types, outside of the IDL, such as reusing a
         QGeoCoordinate inside a QFace IDL.
+    \li Defined Interfaces can't be used as types in properties or function arguments.
     \li The \c map<> type is not supported.
     \li Any default values provided directly in the QFace file are currently ignored.
     \li The \c ivigenerator uses it's own YAML template, that's incorporated with QFace's YAML to
diff --git a/src/ivicore/doc/src/qtivi.qdoc b/src/ivicore/doc/src/qtivi.qdoc
index 5d3aca6..697594e 100644
--- a/src/ivicore/doc/src/qtivi.qdoc
+++ b/src/ivicore/doc/src/qtivi.qdoc
@@ -32,7 +32,7 @@
 
     The Qt In-Vehicle Infotainment (IVI) module provides both, the tools and the core APIs, for you
     to implement Middleware APIs, Middleware Backends, and Middlware Services. The
-    \l{Qt IVI Autogenerator} provides a flexible way to define new APIs via an Interface Definition
+    \l{Qt IVI Generator} provides a flexible way to define new APIs via an Interface Definition
     Language (IDL) and generate classes for use, from C++ and QML.
 
     Qt IVI is built around a pattern that separates the API exposed to the application developer,
@@ -64,6 +64,7 @@
        \li \l{Configuration}
        \li \l{Concepts and Architecture}
        \li \l{Get Started with the Qt IVI Generator}
+       \li \l{Qt IVI Generator Tutorial}
        \li \l{Extending Qt IVI}
     \endlist
 
diff --git a/src/ivicore/qiviabstractfeaturelistmodel.cpp b/src/ivicore/qiviabstractfeaturelistmodel.cpp
index dbd8e3e..d23b77a 100644
--- a/src/ivicore/qiviabstractfeaturelistmodel.cpp
+++ b/src/ivicore/qiviabstractfeaturelistmodel.cpp
@@ -138,7 +138,7 @@ QIviFeatureInterface *QIviAbstractFeatureListModelPrivate::backend() const
 
     \list
         \li For more details on how to integrate with the \l{Dynamic Backend System}, see
-            \l{QIviAbstractFeature::Write a Subclass}{QIviAbstractFeature}.
+            \l{Write a Subclass}{QIviAbstractFeature}.
         \li For more details on what you need to do to provide the model's required
             functionality, see \l{QAbstractListModel - Subclassing}.
         \li For a class that implements all the necessary QIviAbstractFeatureListModel functions
diff --git a/src/ivicore/qivipendingreply.cpp b/src/ivicore/qivipendingreply.cpp
index 8fe9391..1780058 100644
--- a/src/ivicore/qivipendingreply.cpp
+++ b/src/ivicore/qivipendingreply.cpp
@@ -828,9 +828,9 @@ void QIviPendingReplyBase::setSuccessNoCheck(const QVariant &value)
 */
 
 /*!
-    \fn template <class T> QIviPendingReply<T>::setSuccess(const T &value)
+    \fn template <class T> QIviPendingReply<T>::setSuccess(const T &val)
 
-    Sets the result of the reply to \a value and marks the reply as succeeded.
+    Sets the result of the reply to \a val and marks the reply as succeeded.
 
     \note a result can only be set once and cannot be changed again later.
 
diff --git a/src/ivicore/qiviserviceinterface.cpp b/src/ivicore/qiviserviceinterface.cpp
index 06d1885..8fe00a7 100644
--- a/src/ivicore/qiviserviceinterface.cpp
+++ b/src/ivicore/qiviserviceinterface.cpp
@@ -85,7 +85,7 @@ QIviServiceInterface::~QIviServiceInterface()
 /*!
     \fn QObject* QIviServiceInterface::interfaceInstance(const QString& interfaceName) const
 
-    Returns an object implementing the service interface requested through \a interface.
+    Returns an object implementing the service interface requested through \a interfaceName.
 */
 
 QT_END_NAMESPACE
diff --git a/src/ivicore/qivisimulationglobalobject.cpp b/src/ivicore/qivisimulationglobalobject.cpp
index db312b6..48b413a 100644
--- a/src/ivicore/qivisimulationglobalobject.cpp
+++ b/src/ivicore/qivisimulationglobalobject.cpp
@@ -401,12 +401,12 @@ QString QIviSimulationGlobalObject::constraint(const QVariantMap &data, const QS
 }
 
 /*!
-    \qmlmethod IviSimulator::checkSettings(object data, var data, string zone)
+    \qmlmethod IviSimulator::checkSettings(object data, var value, string zone)
 
     Searches for all boundary settings in \a data for the given \a zone and returns whether the
-    provided \a value meets this contraint.
+    provided \a value meets this constraint.
 
-    To show meaningful error messages when the value is not within the boundaries, the contraint()
+    To show meaningful error messages when the value is not within the boundaries, the constraint()
     function can be used.
 
     \sa constraint()
diff --git a/src/ivicore/qtivicoremodule.cpp b/src/ivicore/qtivicoremodule.cpp
index 18836de..576fd01 100644
--- a/src/ivicore/qtivicoremodule.cpp
+++ b/src/ivicore/qtivicoremodule.cpp
@@ -69,7 +69,7 @@ QObject* serviceManagerSingelton(QQmlEngine *, QJSEngine *)
     \inmodule QtIviCore
 
     \brief The QtIviCoreModule class holds enums which are used by multiple classes of QtIviCore
-    and provides convenience functions to register types to QML
+    and provides convenience functions to register types to QML.
 */
 
 /*!