summaryrefslogtreecommitdiffstats
path: root/doc/installerfw-cpp-classes.qdoc
blob: 6b22c92a8aea74d1339e89a47f39a8e5d953c0c6 (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
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Installer Framework.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt 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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://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: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \contentspage {index.html}{Qt Installer Framework}
    \previouspage Scripting API
    \page ifw-cpp-classes.html
    \nextpage ifw-knownissues.html

    \title C++ API

    The C++ API documentation is written for developers who develop the Qt
    Installer Framework. It describes the internal API, so there is no
    compatibility promise. Further, the documentation is a work in progress and
    therefore parts of it are missing while other parts might be out of date.

    To create customized installers, use the \l{Scripting API}, instead. For
    more information, see \l {Customizing Installers}.

    \section1 Namespaces

    \table
    \header
        \li Namespace
        \li Description
    \row
        \li \l{qinstaller-module}{QInstaller}
        \li Contains classes to implement the core functionality of the Qt
            Installer Framework and the installer UI.
    \row
        \li \l{KDUpdater}
        \li Contains classes to automatically detect updates to applications,
            to retrieve them from external repositories, and to install them.
            KDUpdater classes are a fork of KDAB's general
            \l{http://docs.kdab.com/kdtools/2.2.2/group__kdupdater.html}
            {KDUpdater module}.
    \endtable

    \section1 QInstaller C++ Classes

    \generatelist{classesbymodule QtInstallerFramework}

    \section1 KDUpdater C++ Classes

    \generatelist{classesbymodule kdupdater}
*/