From eca45594967aba89c124a8b88ee8917b35d76181 Mon Sep 17 00:00:00 2001 From: Katja Marttila Date: Mon, 2 Dec 2019 13:31:27 +0200 Subject: Documentation fixes Change-Id: Ibffb5470d374c8d612791f48c951deddd00f3121 Reviewed-by: Leena Miettinen --- doc/config/ifw.qdocconf | 4 +++- doc/scripting-api/component.qdoc | 8 ++++++++ doc/scripting-api/packagemanagercore.qdoc | 13 +++++++++++++ 3 files changed, 24 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/config/ifw.qdocconf b/doc/config/ifw.qdocconf index 884539f27..d58de3ab4 100644 --- a/doc/config/ifw.qdocconf +++ b/doc/config/ifw.qdocconf @@ -140,4 +140,6 @@ defines += ABSTRACTTASK_H \ UI_PROXYCREDENTIALSDIALOG_H \ UI_SERVERAUTHENTICATIONDIALOG_H \ UNINSTALLERCALCULATOR_H \ - UNZIPTASK_H + UNZIPTASK_H \ + REPOSITORYCATEGORY_H \ + COMPONENTSELECTIONPAGE_P_H diff --git a/doc/scripting-api/component.qdoc b/doc/scripting-api/component.qdoc index 6e55615b7..930d214f2 100644 --- a/doc/scripting-api/component.qdoc +++ b/doc/scripting-api/component.qdoc @@ -358,6 +358,14 @@ \sa dependencies */ +/*! + \qmlmethod void component::addAutoDependOn(string newDependOn) + + Adds the component specified by \a newDependOn to the automatic depend-on list. + + \sa autoDependencies +*/ + /*! \qmlmethod void component::setInstalled() diff --git a/doc/scripting-api/packagemanagercore.qdoc b/doc/scripting-api/packagemanagercore.qdoc index b4fe4c0fb..18b29b9f9 100644 --- a/doc/scripting-api/packagemanagercore.qdoc +++ b/doc/scripting-api/packagemanagercore.qdoc @@ -123,6 +123,13 @@ repository. Progress ranges from 0 to 100. */ +/*! + \qmlsignal installer::metaJobTotalProgress(int progress) + + Triggered when total progress value of the communication with a + remote repository changes. +*/ + /*! \qmlsignal installer::metaJobInfoMessage(string message) @@ -284,6 +291,12 @@ Ensures that component dependencies are re-calculated. */ +/*! + \qmlmethod void installer::clearComponentsToInstallCalculated() + + Forces a recalculation of components to install. +*/ + /*! \qmlmethod void installer::autoAcceptMessageBoxes() -- cgit v1.2.3 From a4b7655164d738313e2b6fdbb846dbf07f2a8950 Mon Sep 17 00:00:00 2001 From: Katja Marttila Date: Mon, 30 Dec 2019 14:08:58 +0200 Subject: Update build instructions to documentation Change-Id: I111829be3183a1e195af4f79c914e6309f9ada9f Reviewed-by: Iikka Eklund --- doc/installerfw-getting-started.qdoc | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'doc') diff --git a/doc/installerfw-getting-started.qdoc b/doc/installerfw-getting-started.qdoc index 7d3300138..a1187c021 100644 --- a/doc/installerfw-getting-started.qdoc +++ b/doc/installerfw-getting-started.qdoc @@ -45,9 +45,9 @@ The installers have been tested on the following platforms: \list - \li Microsoft Windows XP, and later - \li Ubuntu Linux 11.10, and later - \li OS X 10.7, and later + \li Microsoft Windows 7, and later + \li Ubuntu Linux 16.04, and later + \li OS X 10.12, and later \endlist \section1 Building from Sources @@ -59,7 +59,8 @@ \section2 Supported Compilers The Qt Installer Framework can be compiled with Microsoft Visual Studio - 2013 and newer, GCC 4.7 and newer, and Clang 3.1 and newer. + 2013 and newer, GCC 4.7 and newer, and Clang 3.1 and newer. Currently the + tested combination for Windows is Qt5.12.4 with MSVC 2015. \section2 Configuring Qt @@ -69,7 +70,7 @@ from http://doc.qt.io/qt-5/ssl.html if you are statically linking against OpenSSL libraries. - The required Qt version is 5.9.x. + The required Qt version is 5.9.x - 5.12.x. \section3 Configuring Qt for Windows -- cgit v1.2.3 From 4d289c333fd8cc9ca795c24c37adb2e8e40c1653 Mon Sep 17 00:00:00 2001 From: Katja Marttila Date: Tue, 7 Jan 2020 07:54:10 +0200 Subject: Minor documentation fixes Change-Id: I4a8c1ca489ed7d7779c5235101fb57be8bd88274 Reviewed-by: Leena Miettinen --- doc/installerfw-getting-started.qdoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/installerfw-getting-started.qdoc b/doc/installerfw-getting-started.qdoc index a1187c021..b087a2b61 100644 --- a/doc/installerfw-getting-started.qdoc +++ b/doc/installerfw-getting-started.qdoc @@ -47,7 +47,7 @@ \list \li Microsoft Windows 7, and later \li Ubuntu Linux 16.04, and later - \li OS X 10.12, and later + \li macOS 10.12, and later \endlist \section1 Building from Sources @@ -59,8 +59,8 @@ \section2 Supported Compilers The Qt Installer Framework can be compiled with Microsoft Visual Studio - 2013 and newer, GCC 4.7 and newer, and Clang 3.1 and newer. Currently the - tested combination for Windows is Qt5.12.4 with MSVC 2015. + 2013 and newer, GCC 4.7 and newer, and Clang 3.1 and newer. Currently, the + tested combination for Windows is Qt 5.12.4 with MSVC 2015. \section2 Configuring Qt @@ -70,7 +70,7 @@ from http://doc.qt.io/qt-5/ssl.html if you are statically linking against OpenSSL libraries. - The required Qt version is 5.9.x - 5.12.x. + Qt versions between 5.9.0 and 5.12.x are supported. \section3 Configuring Qt for Windows -- cgit v1.2.3