aboutsummaryrefslogtreecommitdiffstats
path: root/src/ivicore/doc/src/qtivicore.qdoc
blob: e73e687c947a3906f756fefe2270224a1ddb5994 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/****************************************************************************
**
** Copyright (C) 2019 Luxoft Sweden AB
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the QtIvi module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite licenses may use
** this file in accordance with the commercial license agreement provided
** with the Software or, alternatively, in accordance with the terms
** contained in a written agreement between you and The Qt Company.  For
** licensing terms and conditions see https://www.qt.io/terms-conditions.
** For further information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \module QtIviCore
    \title Qt IVI Core C++ Classes
    \ingroup modules
    \ingroup qtivi_modules
    \qtvariable ivicore

    \brief C++ classes for the Qt IVI Core API.

    To include the definitions of the module's classes, use the following directive:

    \code
    #include <QtIviCore>
    \endcode

    To link against the module, add this line to your qmake .pro file:

    \code
    QT += ivicore
    \endcode

    For more information, see \l{Use the Qt IVI Reference API}.
*/

/*!
    \qmlmodule QtIvi 1.0
    \title Qt IVI Core QML Types
    \ingroup qmlmodules
    \ingroup qtivi_qmlmodules

    \brief QML types for the Qt IVI Core API.

    The Qt IVI Core QML API provides core functions for in-vehicle infotainment QML types.

    To import the QML types into your application, use the following import statement
    in your .qml file:

    \code
    import QtIvi 1.0
    \endcode

    \section1 QML Types
*/

/*!
    \group qtivicore-examples
    \ingroup all-examples
    \ingroup qtivi-examples
    \title Qt IVI Core Examples

    \brief Examples for using the Qt IVI Core features

    These are the Qt IVI Core features examples.
*/