diff options
| -rw-r--r-- | src/doc/qtivi/src/configuration.qdoc | 2 | ||||
| -rw-r--r-- | src/doc/qtivi/src/qtivi.qdoc | 25 | ||||
| -rw-r--r-- | src/doc/qtivi/src/reference-api.qdoc | 43 |
3 files changed, 27 insertions, 43 deletions
diff --git a/src/doc/qtivi/src/configuration.qdoc b/src/doc/qtivi/src/configuration.qdoc index 3892ab5..6b1be4d 100644 --- a/src/doc/qtivi/src/configuration.qdoc +++ b/src/doc/qtivi/src/configuration.qdoc @@ -118,6 +118,8 @@ The following environment variables are supported for runtime configurations: enabled. \endtable +Also see the documentation about the \l {QtIvi Backends} {backend plugins} for more runtime configuration options. + \section2 Logging The \e qt.ivi.servicemanagement Logging Category can be used to get more information on which diff --git a/src/doc/qtivi/src/qtivi.qdoc b/src/doc/qtivi/src/qtivi.qdoc index 693a722..c51aa83 100644 --- a/src/doc/qtivi/src/qtivi.qdoc +++ b/src/doc/qtivi/src/qtivi.qdoc @@ -31,7 +31,7 @@ The Qt IVI (In-Vehicle Infotainment) module provides C++ classes and QML types for accessing vehicle features, as well as a core API for implementing - new IVI features. + new IVI features manually or using a \l {The Qt IVI Autogenerator}{auto generator}. The module is built around a pattern based on the separation of API facing the application developer, the so called \e {Feature}, and the code implementing it, @@ -64,29 +64,6 @@ \li \l{QtIvi Backends}{Available Backends} \endlist - \section1 Modules - - Qt IVI consists of the following C++ modules: - - \annotatedlist qtivi_modules - - \b {Qt IVI Core} provides core base classes for the Qt IVI features, - and handles the discovery of Qt IVI backend plugins. Application - developers do not need to use Qt IVI Core directly. It is only needed - when implementing a new IVI feature, such as Qt IVI Vehicle Functions - ClimateControl. - - \b {Qt IVI Vehicle Functions} provides interfaces to access vehicle - features. - - \b {Qt IVI Media} provides interfaces to access media related APIs e.g. - Managing your music playlist or controlling the radio tuner. - - The functionality provided by these modules is available to QML - applications: - - \annotatedlist qtivi_qmlmodules - \section1 Getting Started \list diff --git a/src/doc/qtivi/src/reference-api.qdoc b/src/doc/qtivi/src/reference-api.qdoc index 3a06be2..d1bab1d 100644 --- a/src/doc/qtivi/src/reference-api.qdoc +++ b/src/doc/qtivi/src/reference-api.qdoc @@ -33,23 +33,28 @@ 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. - -The feature areas covered by the Qt IVI module reference API are: - -\list - \li Vehicle Functions - \list - \li \l {QIviClimateControl} {Climate Control} - \li \l {QIviWindowControl} {Window Control} - \endlist -\omit - \li Media Management - \list - \li Search and Browse - \li Playqueue Management - \li Playback Control - \endlist -\endomit -\endlist +zones and property attributes. More about the concepts can be read \l {Concepts} {here}. + +\section1 Modules + +Qt IVI consists of the following C++ modules: + +\annotatedlist qtivi_modules + +\b {Qt IVI Core} provides core base classes for the Qt IVI features, +and handles the discovery of Qt IVI backend plugins. Application +developers do not need to use Qt IVI Core directly. It is only needed +when implementing a new IVI feature, such as Qt IVI Vehicle Functions +ClimateControl. + +\b {Qt IVI Vehicle Functions} provides interfaces to access vehicle +features. + +\b {Qt IVI Media} provides interfaces to access media related APIs e.g. +Managing your music playlist or controlling the radio tuner. + +The functionality provided by these modules is available to QML +applications: + +\annotatedlist qtivi_qmlmodules */ |