summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2015-01-14 14:58:18 +0100
committerLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2015-01-15 11:52:48 +0100
commit91b5f01dfbb56683d5b1acafd45131e1cf19c5d1 (patch)
treeb280424323b0cfaa4466401d06f39b870d934d22 /doc
parentfb6ed7865fcffa4a264b0edcb64b1d219c8a66e9 (diff)
Doc: add disclaimer to the C++ class reference
This reference is meant for Qt Installer Developers, not typical users. Change-Id: Ie256e8fceac859380434ce67c84d4024684661ae Reviewed-by: Niels Weber <niels.weber@theqtcompany.com> Reviewed-by: Jarek Kobus <jaroslaw.kobus@theqtcompany.com> Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/installerfw-cpp-classes.qdoc8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/installerfw-cpp-classes.qdoc b/doc/installerfw-cpp-classes.qdoc
index d9082052f..04d077314 100644
--- a/doc/installerfw-cpp-classes.qdoc
+++ b/doc/installerfw-cpp-classes.qdoc
@@ -33,6 +33,14 @@
\title C++ Classes
+ The class 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}.
+
\generatelist{classesbymodule QtInstallerFramework}
\generatelist{classesbymodule kdupdater}
*/