Fix qdoc errors and some broken links

Change-Id: Ibc5b81bc622c871884d3c7ab5fac467deabe0340
Reviewed-by: Robert Griebl <robert.griebl@pelagicore.com>

21 files changed, 70 insertions, 39 deletions

diff --git a/src/ivicore/doc/src/examples-qface-ivi-addressbook.qdoc b/src/ivicore/doc/src/examples-qface-ivi-addressbook.qdoc
index 9e135df..5becc79 100644
--- a/src/ivicore/doc/src/examples-qface-ivi-addressbook.qdoc
+++ b/src/ivicore/doc/src/examples-qface-ivi-addressbook.qdoc
@@ -27,7 +27,7 @@
 
 /*!
 \example ivicore/qface-ivi-addressbook
-\brief This example shows how to generate models using the Qt IVI Generator
+\brief This example shows how to generate models using the Qt IVI Generator.
 \ingroup qtivicore-examples
 \title Qt IVI Generator Addressbook Example
 \image examples_qface_ivi_addressbook.png
@@ -38,8 +38,8 @@ This example shows how to generate a model using the \e model type in a qface fi
 Generator.
 
 It will only explain the details on how to use the \e model type and how it works internally. For a
-general introduction to the Qt IVI Generator, please have a look at the \l qface-ivi-climate
-example.
+general introduction to the Qt IVI Generator, please have a look at the
+\l {ivicore/qface-ivi-climate} {Qt IVI Generator Climate Example}.
 
 \section2 Walkthrough
 
diff --git a/src/ivicore/doc/src/examples-qface-ivi-climate.qdoc b/src/ivicore/doc/src/examples-qface-ivi-climate.qdoc
index 3305951..d14ea50 100644
--- a/src/ivicore/doc/src/examples-qface-ivi-climate.qdoc
+++ b/src/ivicore/doc/src/examples-qface-ivi-climate.qdoc
@@ -29,7 +29,7 @@
 \example ivicore/qface-ivi-climate
 \brief This Example shows how to use the Qt IVI Generator.
 \ingroup qtivicore-examples
-\title Qt IVI Generator Example
+\title Qt IVI Generator Climate Example
 \image examples_qface_ivi_climate.png
 
 \section1 Introduction
diff --git a/src/ivicore/doc/src/ivigenerator/getting-started.qdoc b/src/ivicore/doc/src/ivigenerator/getting-started.qdoc
index eed6cb2..6baf1ed 100644
--- a/src/ivicore/doc/src/ivigenerator/getting-started.qdoc
+++ b/src/ivicore/doc/src/ivigenerator/getting-started.qdoc
@@ -67,7 +67,7 @@ how Qt locates and loads its plugins, please see \l {How to Create Qt Plugins} {
 
 \section1 In Depth Walkthrough
 
-For more in-depth information, the \l {Qt IVI Generator Example} comes with a step by step documentation.
+For more in-depth information, the \l {Qt IVI Generator Climate Example} comes with a step by step documentation.
 */
 
 /*
diff --git a/src/ivicore/doc/src/models.qdoc b/src/ivicore/doc/src/models.qdoc
index 3558ab9..21c89d7 100644
--- a/src/ivicore/doc/src/models.qdoc
+++ b/src/ivicore/doc/src/models.qdoc
@@ -79,10 +79,11 @@ QIviPagingModel are provided by QIviStandardItem or classes derived from it. The
 provide the data to the QIviPagingModel is to create a new class derived from QIviStandardItem and
 override the "name" and "type" accessor functions. The "name" and "type" properties of every
 QIviStandardItem can be retrieved directly from the data() function of the model. This also exposes
-those properties to delegates in item views (e.g. ListView). In addition the \l{ItemRole} provides
-a const pointer to the stored QIviStandardItem. Using the MetaObject-System all the properties of
-the derived type are also available in QML directly using this pointer. From C++ the at() template
-function can be used to cast it directly to the needed type.
+those properties to delegates in item views (e.g. ListView). In addition the
+\l{QIviPagingModel::}{ItemRole} provides a const pointer to the stored QIviStandardItem. Using the
+MetaObject-System all the properties of the derived type are also available in QML directly using
+this pointer. From C++ the at() template function can be used to cast it directly to the needed
+type.
 
 \section1 The QIviSearchAndBrowseModel
 
diff --git a/src/ivicore/doc/src/reference-api.qdoc b/src/ivicore/doc/src/reference-api.qdoc
index d1bab1d..b3e71f4 100644
--- a/src/ivicore/doc/src/reference-api.qdoc
+++ b/src/ivicore/doc/src/reference-api.qdoc
@@ -33,7 +33,7 @@
 The Qt IVI module contains a reference API providing interfaces to common automotive
 functionality. These APIs rely on the separation of the front-end API and the backend
 implementation. The Qt IVI module also introduces a set of concepts used in the APIs:
-zones and property attributes. More about the concepts can be read \l {Concepts} {here}.
+zones and property attributes. More about the concepts can be read \l {Concepts / Architecture} {here}.
 
 \section1 Modules
 
diff --git a/src/ivicore/qiviabstractfeature.cpp b/src/ivicore/qiviabstractfeature.cpp
index f0d6038..36dfdb3 100644
--- a/src/ivicore/qiviabstractfeature.cpp
+++ b/src/ivicore/qiviabstractfeature.cpp
@@ -129,7 +129,7 @@ void QIviAbstractFeaturePrivate::onInitializationDone()
 /*!
     \class QIviAbstractFeature
     \inmodule QtIviCore
-    \brief The QIviAbstractFeature is the base class for all QtIvi Features
+    \brief The QIviAbstractFeature is the base class for all QtIvi Features.
 
     QIviAbstractFeature is the base class for the front facing API towards the developer.
     The QIviAbstractFeature provides you with a way to automatically connect to a backend implementing
diff --git a/src/ivicore/qivipendingreply.cpp b/src/ivicore/qivipendingreply.cpp
index f6368bb..44a9452 100644
--- a/src/ivicore/qivipendingreply.cpp
+++ b/src/ivicore/qivipendingreply.cpp
@@ -124,7 +124,7 @@ void QIviPendingReplyWatcherPrivate::callFailedCallback()
 /*!
     \class QIviPendingReplyWatcher
     \inmodule QtIviCore
-    \brief The QIviPendingReplyWatcher provides signals for QIviPendingReply
+    \brief The QIviPendingReplyWatcher provides signals for QIviPendingReply.
 
     The QIviPendingReplyWatcher holds all data of a QIviPendingReply and is implicitly shared
     between copies of the same QIviPendingReply instance. At the same time the watcher provides
@@ -137,7 +137,7 @@ void QIviPendingReplyWatcherPrivate::callFailedCallback()
 /*!
     \class QIviPendingReplyBase
     \inmodule QtIviCore
-    \brief The QIviPendingReplyBase is the base class for QIviPendingReply
+    \brief The QIviPendingReplyBase is the base class for QIviPendingReply.
 
     QIviPendingReplyBase is the base class for QIviPendingReply and provides QVariant based
     functions and properties for the usage from QML.
@@ -152,7 +152,7 @@ void QIviPendingReplyWatcherPrivate::callFailedCallback()
     \instantiates QIviPendingReply
     \inqmlmodule QtIvi
 
-    \brief A object representing an asynchronous results
+    \brief An object representing asynchronous results.
 
     A PendingReply is a way for providing asynchronous results. It can be used as a
     return value for asynchronous functions.
@@ -258,7 +258,7 @@ void QIviPendingReplyWatcherPrivate::callFailedCallback()
 /*!
     \class QIviPendingReply
     \inmodule QtIviCore
-    \brief Template class for providing asynchronous results
+    \brief Template class for providing asynchronous results.
 
     A QIviPendingReply is a template class for providing asynchronous results. It can be used as a
     return value for asynchronous functions, similar to QFuture.
diff --git a/src/ivicore/qiviproperty.cpp b/src/ivicore/qiviproperty.cpp
index 06c27a2..b59fb5c 100644
--- a/src/ivicore/qiviproperty.cpp
+++ b/src/ivicore/qiviproperty.cpp
@@ -78,7 +78,7 @@ void QIviPropertyPrivate::throwError(QObject *object, const QString &error)
     \class QIviProperty
     \obsolete
     \inmodule QtIviCore
-    \brief The QIviProperty combines a normal property and a QIviPropertyAttribute
+    \brief The QIviProperty combines a normal property and a QIviPropertyAttribute.
 
     The QIviProperty is used to retrieve the value of a property and its corresponding
     QIviPropertyAttribute in an easy way. It's designed for QML (but is not limited to)
diff --git a/src/ivicore/qivipropertyattribute.cpp b/src/ivicore/qivipropertyattribute.cpp
index 0423a03..fb1e347 100644
--- a/src/ivicore/qivipropertyattribute.cpp
+++ b/src/ivicore/qivipropertyattribute.cpp
@@ -64,7 +64,7 @@ void QIviPropertyAttributeBase::registerTypes()
     \class QIviPropertyAttribute
     \obsolete
     \inmodule QtIviCore
-    \brief The QIviPropertyAttribute encapsulates the attributes of a property
+    \brief The QIviPropertyAttribute encapsulates the attributes of a property.
 
     QIviPropertyAttribute sets the boundaries for a property in Qt IVI. In a
     Qt IVI backend interface, the QIviPropertyAttributes are used to control
diff --git a/src/ivicore/qivipropertyfactory.cpp b/src/ivicore/qivipropertyfactory.cpp
index 72f320a..1feaf0e 100644
--- a/src/ivicore/qivipropertyfactory.cpp
+++ b/src/ivicore/qivipropertyfactory.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
     \class QIviPropertyFactory
     \obsolete
     \inmodule QtIviCore
-    \brief The QIviPropertyFactory is used as a factory class for creating instances of QIviProperty
+    \brief The QIviPropertyFactory is used as a factory class for creating instances of QIviProperty.
 
     QIviPropertyFactory will preserve the type information about the template type in QIviProperty and
     does a compile time check whether all provided functions and signals match this type and each other.
diff --git a/src/ivicore/qiviproxyserviceobject.cpp b/src/ivicore/qiviproxyserviceobject.cpp
index 941f379..b6d0d24 100644
--- a/src/ivicore/qiviproxyserviceobject.cpp
+++ b/src/ivicore/qiviproxyserviceobject.cpp
@@ -59,7 +59,7 @@ QIviProxyServiceObjectPrivate::QIviProxyServiceObjectPrivate(const QHash<QString
     \class QIviProxyServiceObject
     \inmodule QtIviCore
     \brief QIviProxyServiceObject is a helper class to connect a Feature to already instantiated
-    QIviServiceInterface classes
+    QIviServiceInterface classes.
 
     In constrast to the QIviServiceObject which is created for you by the QIviServiceManager for
     every backend plugin, the QIviProxyServiceObject can be instantiated by the user and then
diff --git a/src/ivicore/qiviservicemanager.cpp b/src/ivicore/qiviservicemanager.cpp
index 7ce232b..0adea74 100644
--- a/src/ivicore/qiviservicemanager.cpp
+++ b/src/ivicore/qiviservicemanager.cpp
@@ -388,7 +388,7 @@ QIviServiceInterface *QIviServiceManagerPrivate::loadServiceBackendInterface(str
 /*!
     \class QIviServiceManager
     \inmodule QtIviCore
-    \brief QIviServiceManager provides the Backends to QIviAbstractFeature
+    \brief QIviServiceManager provides the backends to QIviAbstractFeature.
 
     QIviServiceManager is the heart of QtIvi and provides you with an easy way to detect which
     backends and interfaces are available.
@@ -453,7 +453,7 @@ QIviServiceInterface *QIviServiceManagerPrivate::loadServiceBackendInterface(str
     \instantiates QIviServiceManager
     \inqmlmodule QtIvi
 
-    \brief The ServiceManager is the central instance loading the backends and providing ServiceObjects
+    \brief The ServiceManager is the central instance loading the backends and providing ServiceObjects.
 
     The ServiceManager singleton provides a model which can be used to list all available backends
     and their interfaces.
diff --git a/src/ivicore/queryparser/qiviqueryterm.cpp b/src/ivicore/queryparser/qiviqueryterm.cpp
index 5de9fc8..6808130 100644
--- a/src/ivicore/queryparser/qiviqueryterm.cpp
+++ b/src/ivicore/queryparser/qiviqueryterm.cpp
@@ -89,7 +89,7 @@ QIviOrderTermPrivate::QIviOrderTermPrivate(const QIviOrderTermPrivate &other)
 /*!
     \class QIviAbstractQueryTerm
     \inmodule QtIviCore
-    \brief The base class of all query terms
+    \brief The base class of all query terms.
 
     Following terms are supported:
     \annotatedlist qtivi_queryterms
@@ -127,7 +127,7 @@ QIviAbstractQueryTerm::~QIviAbstractQueryTerm()
     \class QIviConjunctionTerm
     \inmodule QtIviCore
     \ingroup qtivi_queryterms
-    \brief The QIviConjunctionTerm is the representation of a conjunction between two query terms
+    \brief The QIviConjunctionTerm is the representation of a conjunction between two query terms.
 */
 
 /*!
@@ -197,7 +197,7 @@ QList<QIviAbstractQueryTerm *> QIviConjunctionTerm::terms() const
     \class QIviScopeTerm
     \inmodule QtIviCore
     \ingroup qtivi_queryterms
-    \brief The QIviScopeTerm is the representation of a scope which can hold another term
+    \brief The QIviScopeTerm is the representation of a scope which can hold another term.
 */
 QIviScopeTerm::QIviScopeTerm()
     : d_ptr(new QIviScopeTermPrivate)
@@ -256,7 +256,7 @@ QIviAbstractQueryTerm *QIviScopeTerm::term() const
     \class QIviFilterTerm
     \inmodule QtIviCore
     \ingroup qtivi_queryterms
-    \brief The QIviFilterTerm is the representation of a filter
+    \brief The QIviFilterTerm is the representation of a filter.
 
     The filter is either in the form:
 
@@ -362,7 +362,7 @@ bool QIviFilterTerm::isNegated() const
 /*!
     \class QIviOrderTerm
     \inmodule QtIviCore
-    \brief The QIviOrderTerm is the representation of a scope which can hold another term
+    \brief The QIviOrderTerm is the representation of a scope which can hold another term.
 */
 QIviOrderTerm::QIviOrderTerm()
     : d(new QIviOrderTermPrivate)
diff --git a/src/ivimedia/qiviamfmtuner.cpp b/src/ivimedia/qiviamfmtuner.cpp
index d9ed2ad..cec62e5 100644
--- a/src/ivimedia/qiviamfmtuner.cpp
+++ b/src/ivimedia/qiviamfmtuner.cpp
@@ -153,9 +153,9 @@ QIviAmFmTunerBackendInterface *QIviAmFmTunerPrivate::tunerBackend() const
 /*!
     \class QIviAmFmTuner
     \inmodule QtIviMedia
-    \brief Provides a interface to control the am fm tuner
+    \brief Provides a interface to control the AM/FM tuner.
 
-    The QIviAmFmTuner provides the methods to control a am/fm tuner.
+    The QIviAmFmTuner provides the methods to control a AM/FM tuner.
 */
 
 /*!
@@ -163,9 +163,9 @@ QIviAmFmTunerBackendInterface *QIviAmFmTunerPrivate::tunerBackend() const
     \instantiates QIviAmFmTuner
     \inqmlmodule QtIvi.Media
     \inherits AbstractFeature
-    \brief Provides a interface to control the am fm tuner
+    \brief Provides a interface to control the AM/FM tuner.
 
-    The AmFmTuner provides the methods to control a am/fm tuner.
+    The AmFmTuner provides the methods to control a AM/FM tuner.
 */
 
 /*!
diff --git a/src/ivimedia/qivimediadevice.cpp b/src/ivimedia/qivimediadevice.cpp
index 55e11d0..f48fc76 100644
--- a/src/ivimedia/qivimediadevice.cpp
+++ b/src/ivimedia/qivimediadevice.cpp
@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
 /*!
     \class QIviMediaDevice
     \inmodule QtIviMedia
-    \brief QIviMediaDevice is the base class for all Media Devices
+    \brief QIviMediaDevice is the base class for all media devices.
 
     A Media Device is an externally or internally connected device on which media is stored.
     It can be a physical medium like a USB thumbdrive or a CD/DVD, but it could also be a DLNA Media Server running
@@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE
     \instantiates QIviMediaDevice
     \inqmlmodule QtIvi.Media
     \inherits ServiceObject
-    \brief MediaDevice is the base item for all Media Devices
+    \brief MediaDevice is the base item for all Media Devices.
 
     A Media Device is an externally or internally connected device on which media is stored.
     It can be a physical medium like a USB thumbdrive or a CD/DVD, but it could also be a DLNA Media Server running
diff --git a/src/ivimedia/qivimediaindexercontrol.cpp b/src/ivimedia/qivimediaindexercontrol.cpp
index 261faab..acde486 100644
--- a/src/ivimedia/qivimediaindexercontrol.cpp
+++ b/src/ivimedia/qivimediaindexercontrol.cpp
@@ -89,7 +89,7 @@ QIviMediaIndexerControlBackendInterface *QIviMediaIndexerControlPrivate::indexer
 /*!
     \class QIviMediaIndexerControl
     \inmodule QtIviMedia
-    \brief Provides a interface to control the media indexer
+    \brief Provides an interface to control the media indexer.
 
     The QIviMediaIndexerControl controls the media indexer. It provides a way to temporarily pause the indexing
     and resume it, as well as to inquire about the current state and progress of the indexing operation.
@@ -103,7 +103,7 @@ QIviMediaIndexerControlBackendInterface *QIviMediaIndexerControlPrivate::indexer
     \instantiates QIviMediaIndexerControl
     \inqmlmodule QtIvi.Media
     \inherits AbstractFeature
-    \brief Provides a interface to control the media indexer
+    \brief Provides an interface to control the media indexer.
 
     The MediaIndexerControl controls the media indexer. It provides a way to temporarily pause the indexing
     and resume it, as well as to inquire about the current state and progress of the indexing operation.
diff --git a/src/ivimedia/qivimediaplayer.cpp b/src/ivimedia/qivimediaplayer.cpp
index 0dfcb57..d30ffac 100644
--- a/src/ivimedia/qivimediaplayer.cpp
+++ b/src/ivimedia/qivimediaplayer.cpp
@@ -167,7 +167,7 @@ QIviMediaPlayerBackendInterface *QIviMediaPlayerPrivate::playerBackend() const
 /*!
     \class QIviMediaPlayer
     \inmodule QtIviMedia
-    \brief Provides a interface to control a media player
+    \brief Provides an interface to control a media player.
 
     The QIviMediaPlayer provides methods to control a media player. This media player can
     be local or even a remote device you are connected to e.g. over bluetooth.
@@ -181,7 +181,7 @@ QIviMediaPlayerBackendInterface *QIviMediaPlayerPrivate::playerBackend() const
     \instantiates QIviMediaPlayer
     \inqmlmodule QtIvi.Media
     \inherits AbstractFeature
-    \brief Provides a interface to control a media player
+    \brief Provides an interface to control a media player.
 
     The MediaPlayer provides methods to control a media player. This media player can
     be local or even a remote device you are connected to e.g. over bluetooth.
diff --git a/src/ivimedia/qivimediaplayerbackendinterface.cpp b/src/ivimedia/qivimediaplayerbackendinterface.cpp
index 6ab10dd..43f6632 100644
--- a/src/ivimedia/qivimediaplayerbackendinterface.cpp
+++ b/src/ivimedia/qivimediaplayerbackendinterface.cpp
@@ -144,6 +144,22 @@ QIviMediaPlayerBackendInterface::QIviMediaPlayerBackendInterface(QObject *parent
 */
 
 /*!
+    \fn QIviMediaPlayerBackendInterface::setVolume(int volume)
+
+    Sets the current player \a volume. The value needs to be between 0 and 100.
+
+    \sa volumeChanged
+*/
+
+/*!
+    \fn QIviMediaPlayerBackendInterface::setMuted(bool muted)
+
+    When \a muted is set to \e true, the player will be muted and un-muted otherwise.
+
+    \sa mutedChanged
+*/
+
+/*!
     \fn QIviMediaPlayerBackendInterface::canReportCount()
 
     Returns \e true if the backend can return the final number of items for a specific request. This makes it possible to support the QIviPlayQueue::DataChanged loading
@@ -223,6 +239,18 @@ QIviMediaPlayerBackendInterface::QIviMediaPlayerBackendInterface(QObject *parent
 */
 
 /*!
+    \fn QIviMediaPlayerBackendInterface::volumeChanged(int volume)
+
+    Emitted when the volume of this player changed. The new volume of the player will be passed as \a volume.
+*/
+
+/*!
+    \fn QIviMediaPlayerBackendInterface::mutedChanged(bool muted)
+
+    Emitted when the player changes its mute state. The player is muted when \a muted is set to \e true.
+*/
+
+/*!
     \fn QIviMediaPlayerBackendInterface::countChanged(int newLength)
 
     This signal is emitted once the backend knows about the new size of the play queue.
diff --git a/src/ivimedia/qiviplayqueue.cpp b/src/ivimedia/qiviplayqueue.cpp
index 00ae4db..a4f8644 100644
--- a/src/ivimedia/qiviplayqueue.cpp
+++ b/src/ivimedia/qiviplayqueue.cpp
@@ -216,7 +216,7 @@ QIviMediaPlayerBackendInterface *QIviPlayQueuePrivate::playerBackend() const
 /*!
     \class QIviPlayQueue
     \inmodule QtIviMedia
-    \brief Provides a play queue for the QIviMediaPlayer
+    \brief Provides a play queue for the QIviMediaPlayer.
 
     The QIviPlayQueue is a model which is used by the QIviMediaPlayer to control the
     play order of QIviPlayableItems.
@@ -278,7 +278,7 @@ QIviMediaPlayerBackendInterface *QIviPlayQueuePrivate::playerBackend() const
     \instantiates QIviPlayQueue
     \inqmlmodule QtIvi.Media
     \inherits QAbstractListModel
-    \brief Provides a play queue for the MediaPlayer
+    \brief Provides a play queue for the MediaPlayer.
 
     The PlayQueue is a model which is used by the MediaPlayer to control the
     play order of PlayableItems.
diff --git a/src/tools/ivigenerator/common/qtivi_macros.j2 b/src/tools/ivigenerator/common/qtivi_macros.j2
index 1cb9e0d..b8acf54 100644
--- a/src/tools/ivigenerator/common/qtivi_macros.j2
+++ b/src/tools/ivigenerator/common/qtivi_macros.j2
@@ -208,6 +208,7 @@ void {{scope}}{{sig}}({{join_params(signal, zoned)}})
 {% with doc = comments|parse_doc -%}
 {% if doc.brief %}    \brief {{doc.brief|join(' ')| wordwrap(width=100, wrapstring='\n    ')}}
 {% endif %}
+
 {% if doc.description %}
     {{doc.description|join(' ')| wordwrap(width=100, wrapstring='\n    ')}}{% endif %}
 {% endwith -%}
diff --git a/src/tools/ivigenerator/templates_frontend/backendinterface.cpp.tpl b/src/tools/ivigenerator/templates_frontend/backendinterface.cpp.tpl
index d39384b..f6366a5 100644
--- a/src/tools/ivigenerator/templates_frontend/backendinterface.cpp.tpl
+++ b/src/tools/ivigenerator/templates_frontend/backendinterface.cpp.tpl
@@ -56,7 +56,8 @@ QT_BEGIN_NAMESPACE
     \keyword {{interface.tags.config.id | default(interface.qualified_name)}}
 
     \brief Backend interface for {{interface}}.
-    The {{class}} is the interface used by \l {{interface}}
+
+    The {{class}} is the interface used by \l {{interface}}.
 
     The interface is discovered by a \l {{interface}} object, which connects to it and sets up
     the connections to it.