installer-framework/doc/installerfw-cpp-classes.qdoc
Katja Marttila c9d11cc991 License header update to GPL-EXCEPT
Change-Id: I6426c4e8f932cf26c6c638dec18d0c12e22972d1
Reviewed-by: Janne Anttila <janne.anttila@theqtcompany.com>
2017-01-26 10:02:56 +00:00

71 lines
2.6 KiB
Plaintext

/****************************************************************************
**
** 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}
*/