summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/messageboxhandler.qdoc14
-rw-r--r--doc/scripting-api/component.qdoc20
-rw-r--r--doc/scripting-api/packagemanagercore.qdoc44
-rw-r--r--doc/scripting-api/qdesktopservices.qdoc4
-rw-r--r--examples/doc/systeminfo.qdoc6
-rw-r--r--src/libs/installer/protocol.cpp8
-rw-r--r--src/libs/installer/proxycredentialsdialog.cpp4
7 files changed, 56 insertions, 44 deletions
diff --git a/doc/messageboxhandler.qdoc b/doc/messageboxhandler.qdoc
index 259dfc490..30f0b2723 100644
--- a/doc/messageboxhandler.qdoc
+++ b/doc/messageboxhandler.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2017 The Qt Company Ltd.
+** Copyright (C) 2021 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Installer Framework.
@@ -79,26 +79,30 @@
\qmlmethod Button QMessageBox::critical(string identifier, string title, string text,
Buttons buttons = QMessageBox.Ok, Button button = QMessageBox.NoButton)
- Opens a critical message box with the given \a title and \a text.
+ Opens a critical message box with the parent \a parent, identifier \a identifier,
+ title \a title, and text \a text.
*/
/*!
\qmlmethod Button QMessageBox::information(string identifier, string title, string text,
Buttons buttons = QMessageBox.Ok, Button button = QMessageBox.NoButton)
- Opens an information message box with the given \a title and \a text.
+ Opens an information message box with the parent \a parent, identifier \a identifier,
+ title \a title, and text \a text.
*/
/*!
\qmlmethod Button QMessageBox::question(string identifier, string title, string text,
Buttons buttons = QMessageBox.Yes | QMessageBox.No, Button button = QMessageBox.NoButton)
- Opens a question message box with the given \a title and \a text.
+ Opens a question message box with the parent \a parent, identifier \a identifier,
+ title \a title, and text \a text.
*/
/*!
\qmlmethod Button QMessageBox::warning(string identifier, string title, string text,
Buttons buttons = QMessageBox.Ok, Button button = QMessageBox.NoButton)
- Opens a warning message box with the given \a title and \a text.
+ Opens a warning message box with the parent \a parent, identifier \a identifier,
+ title \a title, and text \a text.
*/
diff --git a/doc/scripting-api/component.qdoc b/doc/scripting-api/component.qdoc
index c253767b3..00480cd63 100644
--- a/doc/scripting-api/component.qdoc
+++ b/doc/scripting-api/component.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2017 The Qt Company Ltd.
+** Copyright (C) 2021 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Installer Framework.
@@ -172,7 +172,7 @@
*/
/*!
- \qmlmethod string component::value(string key, string value = "")
+ \qmlmethod string component::value(string key, string defaultValue = "")
Returns the value of variable name \a key. If \a key is not known yet, \a defaultValue is returned.
@@ -317,7 +317,7 @@
/*!
\qmlmethod boolean component::addOperation(string operation, stringlist parameters)
- Creates and adds an installation operation for \a operation. Add any number of parameters.
+ Creates and adds an installation operation for \a operation. Add any number of \a parameters.
The contents of the parameters get variables like "@TargetDir@" replaced with their values,
if contained.
@@ -328,18 +328,20 @@
\qmlmethod boolean component::addOperation(string operation, string parameter1 = "", string parameter2 = "", ..., string parameter10 = "")
Convenience method for calling addOperation(string, stringlist) with up to 10 arguments.
+ Creates and adds an installation operation for \a operation.
*/
/*!
\qmlmethod boolean component::addElevatedOperation(string operation, string parameter1 = "", string parameter2 = "", ..., string parameter10 = "")
Convenience method for calling addElevatedOperation(string, stringlist) with up to 10 arguments.
+ Creates and adds an installation operation for \a operation. The operation is executed with elevated rights.
*/
/*!
\qmlmethod boolean component::addElevatedOperation(string operation, stringlist parameters)
- Creates and adds an installation operation for \a operation. Add any number of parameters.
+ Creates and adds an installation operation for \a operation. Add any number of \a parameters.
The contents of the parameters get variables like "@TargetDir@" replaced with their values,
if contained. \a operation is executed with elevated rights.
*/
@@ -347,7 +349,7 @@
/*!
\qmlmethod void component::setAutoCreateOperations(boolean autoCreateOperations)
- Setter for the \l autoCreateOperations property.
+ Sets the value of \l autoCreateOperations property to \a autoCreateOperations.
*/
/*!
@@ -379,9 +381,9 @@
/*!
\qmlmethod boolean component::isAutoDependOn(QSet<string> componentsToInstall)
- Determines whether the component comes as an auto dependency. Returns \c true if the component needs
- to be installed.
-*/
+ Determines whether the component comes as an auto dependency. Returns \c true if all components
+ in \a componentsToInstall are already installed or selected for installation and this component
+ thus needs to be installed as well.
/*!
\qmlmethod boolean component::isDefault()
@@ -408,7 +410,7 @@
/*!
\qmlmethod void component::setUpdateAvailable(boolean isUpdateAvailable)
- Sets a flag that the core found an update.
+ Sets a flag that the core found an update based on the value of \a isUpdateAvailable.
*/
/*!
diff --git a/doc/scripting-api/packagemanagercore.qdoc b/doc/scripting-api/packagemanagercore.qdoc
index 39387b3ae..3100c9d62 100644
--- a/doc/scripting-api/packagemanagercore.qdoc
+++ b/doc/scripting-api/packagemanagercore.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2020 The Qt Company Ltd.
+** Copyright (C) 2021 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Installer Framework.
@@ -70,7 +70,7 @@
/*!
\qmlsignal installer::componentAdded(Component component)
- Emitted when a new root component is added.
+ Emitted when a new root \a component is added.
\sa rootComponentsAdded(), updaterComponentsAdded()
*/
@@ -78,7 +78,7 @@
/*!
\qmlsignal installer::rootComponentsAdded(list<Component> components)
- Emitted when a new list of root components is added.
+ Emitted when a new list of root \a components is added.
\sa componentAdded(), updaterComponentsAdded()
*/
@@ -86,7 +86,7 @@
/*!
\qmlsignal installer::updaterComponentsAdded(list<Component> components)
- Emitted when a new list of updater components is added.
+ Emitted when a new list of updater \a components is added.
\sa componentAdded(), rootComponentsAdded()
*/
@@ -94,7 +94,7 @@
/*!
\qmlsignal installer::valueChanged(string key, string value)
- Emitted when a value changes.
+ Emitted when a \a value for \a key changes.
\sa setValue()
*/
@@ -102,13 +102,13 @@
/*!
\qmlsignal installer::statusChanged(Status status)
- Emitted when the installer status changes.
+ Emitted when the installer \a status changes.
*/
/*!
\qmlsignal installer::currentPageChanged(int page)
- Emitted when the current page changes.
+ Emitted when the current \a page changes.
*/
/*!
@@ -120,21 +120,21 @@
/*!
\qmlsignal installer::metaJobProgress(int progress)
- Triggered with progress updates of the communication with a remote
+ Triggered with \a progress updates of the communication with a remote
repository. Progress ranges from 0 to 100.
*/
/*!
\qmlsignal installer::metaJobTotalProgress(int progress)
- Triggered when total progress value of the communication with a
+ Triggered when total \a progress value of the communication with a
remote repository changes.
*/
/*!
\qmlsignal installer::metaJobInfoMessage(string message)
- Triggered with informative updates of the communication with a remote repository.
+ Triggered with informative updates, \a message, of the communication with a remote repository.
*/
/*!
@@ -148,7 +148,7 @@
/*!
\qmlsignal installer::finishAllComponentsReset(list<Component> rootComponents)
- Triggered when the list of new root components has been updated.
+ Triggered when the list of new root components \a rootComponents has been updated.
\sa startAllComponentsReset()
*/
@@ -162,7 +162,7 @@
/*!
\qmlsignal installer::finishUpdaterComponentsReset(list<Component> componentsWithUpdates)
- Triggered when the list of available remote updates has been updated.
+ Triggered when the list of available remote updates \a componentsWithUpdates has been updated.
*/
/*!
@@ -272,7 +272,9 @@
\qmlsignal installer::setValidatorForCustomPageRequested(Component component, string name,
string callbackName)
- Triggered when setValidatorForCustomPage is called.
+ Requests that a validator be set for the custom page specified by \a name and
+ \a callbackName for the component \a component. Triggered when
+ setValidatorForCustomPage() is called.
*/
/*!
@@ -406,7 +408,7 @@
/*!
\qmlmethod boolean installer::isFileExtensionRegistered(string extension)
- Returns whether a file extension is already registered in the Windows registry. Returns \c false
+ Returns whether a file \a extension is already registered in the Windows registry. Returns \c false
on all other platforms.
*/
@@ -484,6 +486,9 @@
\qmlmethod void installer::setValidatorForCustomPage(Component component, string name,
string callbackName)
+ Sets a validator for the custom page specified by \a name and \a callbackName
+ for the component \a component.
+
\sa setValidatorForCustomPageRequested()
*/
@@ -521,7 +526,8 @@
/*!
\qmlmethod void installer::setTemporaryRepositories(stringlist repositories, boolean replace)
- Sets additional \a repositories for this instance of the installer or updater.
+ Sets additional \a repositories for this instance of the installer or updater. If \a replace
+ is \c true, existing repositories will be replaced.
Will be removed after invoking it again.
\sa addUserRepositories()
@@ -613,13 +619,13 @@
/*!
\qmlmethod array installer::execute(string program, stringlist arguments = undefined,
- string stdin = "", string stdinCodec = "latin1",
- string stdoutCodec = "latin1")
+ string stdIn = "", string stdInCodec = "latin1",
+ string stdOutCodec = "latin1")
Starts the program \a program with the arguments \a arguments in a
new process and waits for it to finish.
- \a stdin is sent as standard input to the application.
+ \a stdIn is sent as standard input to the application.
\a stdInCodec is the name of the codec to use for converting the input string
into bytes to write to the standard input of the application.
@@ -704,7 +710,7 @@
\qmlmethod void installer::setInstallerBaseBinary(string path)
Sets the \c installerbase binary to use when writing the maintenance tool.
- Set the path if an update to the binary is available.
+ Set the \a path if an update to the binary is available.
If not set, the executable segment of the running installer or uninstaller
will be used.
diff --git a/doc/scripting-api/qdesktopservices.qdoc b/doc/scripting-api/qdesktopservices.qdoc
index 1b639f1e2..126e0b843 100644
--- a/doc/scripting-api/qdesktopservices.qdoc
+++ b/doc/scripting-api/qdesktopservices.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2017 The Qt Company Ltd.
+** Copyright (C) 2021 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Installer Framework.
@@ -104,6 +104,6 @@
\qmlmethod array QDesktopServices::findFiles(string path, string pattern)
Returns file names matching \a pattern. Searches the files recursively from \a path.
- \a Pattern understands * and ? wildcards.
+ The \a pattern understands * and ? wildcards.
*/
diff --git a/examples/doc/systeminfo.qdoc b/examples/doc/systeminfo.qdoc
index 32907ddc3..338cb8f77 100644
--- a/examples/doc/systeminfo.qdoc
+++ b/examples/doc/systeminfo.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2017 The Qt Company Ltd.
+** Copyright (C) 2021 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Installer Framework.
@@ -43,13 +43,13 @@
architecture.
The logic to detect the operating system features is scripted in the
- \c{root}'s \l{systeminfo/packages/root/meta/installscript.qs}{installscript.qs} file.
+ \c{root}'s \c{installscript.qs} file.
\quotefromfile systeminfo/packages/root/meta/installscript.qs
\section1 Helper Functions
- The \l{systeminfo/packages/root/meta/installscript.qs}{installscript.qs} file first
+ The \c{installscript.qs} file first
declares two helper functions: \c cancelInstaller() and \c majorVersion().
\skipto cancelInstaller
diff --git a/src/libs/installer/protocol.cpp b/src/libs/installer/protocol.cpp
index 3bafc481e..fb16086e5 100644
--- a/src/libs/installer/protocol.cpp
+++ b/src/libs/installer/protocol.cpp
@@ -1,6 +1,6 @@
/**************************************************************************
**
-** Copyright (C) 2017 The Qt Company Ltd.
+** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Installer Framework.
@@ -35,19 +35,19 @@ typedef qint32 PackageSize;
/*!
\inmodule QtInstallerFramework
- \namespace Protocol
+ \namespace QInstaller::Protocol
\brief Contains values related to the internal client-server connection protocol.
*/
/*!
- \enum Protocol::Mode
+ \enum QInstaller::Protocol::Mode
\value Debug
\value Production
*/
/*!
- \enum Protocol::StartAs
+ \enum QInstaller::Protocol::StartAs
\value User
\value SuperUser
diff --git a/src/libs/installer/proxycredentialsdialog.cpp b/src/libs/installer/proxycredentialsdialog.cpp
index f536a05cd..2ac07b855 100644
--- a/src/libs/installer/proxycredentialsdialog.cpp
+++ b/src/libs/installer/proxycredentialsdialog.cpp
@@ -1,6 +1,6 @@
/**************************************************************************
**
-** Copyright (C) 2017 The Qt Company Ltd.
+** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Installer Framework.
@@ -34,7 +34,7 @@ namespace QInstaller {
/*!
\inmodule QtInstallerFramework
- \namespace Ui
+ \namespace QInstaller::Ui
\brief Groups user interface forms generated with Qt Designer.
*/
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-25 04:24:51 +0000