summaryrefslogtreecommitdiffstats
path: root/src/libs/installer
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2020-09-02 23:53:35 +0200
committerArttu Tarkiainen <arttu.tarkiainen@qt.io>2020-09-16 13:04:04 +0300
commite1dc7d5340725f04a8e85c7581d4be2387fb423e (patch)
tree12f4442a80a215cf9388d2180a3aa044e4c60f3f /src/libs/installer
parent913c7ea16f961a8f5688734cd12d00fbeaa5d48c (diff)
Doc: Fix documentation warnings
These changes fix many of the documentation warnings when building with a recent version of (Clang-integrated) QDoc. Change-Id: I5714635a25707cd7ab7bec209fa043a95f0b9832 Reviewed-by: Katja Marttila <katja.marttila@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'src/libs/installer')
-rw-r--r--src/libs/installer/abstractfiletask.cpp24
-rw-r--r--src/libs/installer/binaryformat.cpp8
-rw-r--r--src/libs/installer/component.cpp42
-rw-r--r--src/libs/installer/fileutils.cpp4
-rw-r--r--src/libs/installer/lib7z_facade.cpp6
-rw-r--r--src/libs/installer/packagemanagercore.cpp98
-rw-r--r--src/libs/installer/packagemanagercore_p.cpp2
-rw-r--r--src/libs/installer/packagemanagergui.cpp57
-rw-r--r--src/libs/installer/performinstallationform.cpp2
-rw-r--r--src/libs/installer/remotefileengine.cpp16
-rw-r--r--src/libs/installer/repository.cpp2
-rw-r--r--src/libs/installer/scriptengine.cpp2
-rw-r--r--src/libs/installer/utils.cpp2
13 files changed, 126 insertions, 139 deletions
diff --git a/src/libs/installer/abstractfiletask.cpp b/src/libs/installer/abstractfiletask.cpp
index 7e75ed9db..424529fe4 100644
--- a/src/libs/installer/abstractfiletask.cpp
+++ b/src/libs/installer/abstractfiletask.cpp
@@ -62,32 +62,32 @@ namespace QInstaller {
*/
/*!
- \fn FileTaskItem::FileTaskItem()
+ \fn QInstaller::FileTaskItem::FileTaskItem()
Creates a file task item.
*/
/*!
- \fn FileTaskItem::FileTaskItem(const QString &s)
+ \fn QInstaller::FileTaskItem::FileTaskItem(const QString &s)
Creates a file task item using the source specified by \a s.
*/
/*!
- \fn FileTaskItem::FileTaskItem(const QString &s, const QString &t)
+ \fn QInstaller::FileTaskItem::FileTaskItem(const QString &s, const QString &t)
Creates a file task item using the source specified by \a s and target
specified by \a t.
*/
/*!
- \fn FileTaskItem::source() const
+ \fn QInstaller::FileTaskItem::source() const
Returns the source file of the file task item.
*/
/*!
- \fn FileTaskItem::target() const
+ \fn QInstaller::FileTaskItem::target() const
Returns the target file of the file task item.
*/
@@ -99,13 +99,13 @@ namespace QInstaller {
*/
/*!
- \fn FileTaskResult::FileTaskResult()
+ \fn QInstaller::FileTaskResult::FileTaskResult()
Creates file task results.
*/
/*!
- \fn FileTaskResult::FileTaskResult(const QString &t, const QByteArray &c,
+ \fn QInstaller::FileTaskResult::FileTaskResult(const QString &t, const QByteArray &c,
const FileTaskItem &i, bool checksumMismatch)
Creates file task results using the target file specified by \a t, checksum
@@ -114,25 +114,25 @@ namespace QInstaller {
*/
/*!
- \fn FileTaskResult::target() const
+ \fn QInstaller::FileTaskResult::target() const
Returns the target file of the task result.
*/
/*!
- \fn FileTaskResult::checkSum() const
+ \fn QInstaller::FileTaskResult::checkSum() const
Returns the checksum of the task result.
*/
/*!
- \fn FileTaskResult::taskItem() const
+ \fn QInstaller::FileTaskResult::taskItem() const
Returns file task items.
*/
/*!
- \fn FileTaskResult::checksumMismatch() const
+ \fn QInstaller::FileTaskResult::checksumMismatch() const
Returns \c true if checksum mismatch is detected otherwise returns \c false.
*/
@@ -146,7 +146,7 @@ AbstractFileTask::AbstractFileTask()
}
/*!
- \fn AbstractFileTask::~AbstractFileTask()
+ \fn QInstaller::AbstractFileTask::~AbstractFileTask()
Destroys the abstract file task object.
*/
diff --git a/src/libs/installer/binaryformat.cpp b/src/libs/installer/binaryformat.cpp
index 3e7dd5a2a..9ed7742db 100644
--- a/src/libs/installer/binaryformat.cpp
+++ b/src/libs/installer/binaryformat.cpp
@@ -45,7 +45,7 @@ namespace QInstaller {
*/
/*!
- \fn OperationBlob::OperationBlob(const QString &n, const QString &x)
+ \fn QInstaller::OperationBlob::OperationBlob(const QString &n, const QString &x)
Constructs the operation blob with the given arguments, while \a n stands for the name part and
\a x for the XML representation of the operation.
@@ -75,13 +75,13 @@ namespace QInstaller {
*/
/*!
- \fn Range<qint64> Resource::segment() const
+ \fn Range<qint64> QInstaller::Resource::segment() const
Returns the range inside the file this resource represents.
*/
/*!
- \fn void Resource::setSegment(const Range<qint64> &segment)
+ \fn void QInstaller::Resource::setSegment(const Range<qint64> &segment)
Sets the range to the \a segment of the file that this resource represents.
*/
@@ -215,7 +215,7 @@ qint64 Resource::writeData(const char* data, qint64 maxSize)
}
/*!
- \fn void Resource::copyData(QFileDevice *out)
+ \fn void QInstaller::Resource::copyData(QFileDevice *out)
Copies the resource data to a file called \a out. Throws Error on failure.
*/
diff --git a/src/libs/installer/component.cpp b/src/libs/installer/component.cpp
index d716ba5e8..3019831a1 100644
--- a/src/libs/installer/component.cpp
+++ b/src/libs/installer/component.cpp
@@ -74,7 +74,7 @@ static const QLatin1String scExpandedByDefault("ExpandedByDefault");
static const QLatin1String scUnstable("Unstable");
/*!
- \enum Component::UnstableError
+ \enum QInstaller::Component::UnstableError
This enum type holds the component unstable error reason:
@@ -90,7 +90,7 @@ static const QLatin1String scUnstable("Unstable");
/*!
\inmodule QtInstallerFramework
- \class Component::SortingPriorityLessThan
+ \class QInstaller::Component::SortingPriorityLessThan
\brief The SortingPriorityLessThan class sets an increasing sorting order for child components.
If the component contains several children and has this sorting priority set, the child list
@@ -98,14 +98,14 @@ static const QLatin1String scUnstable("Unstable");
*/
/*!
- \fn Component::SortingPriorityLessThan::operator() (const Component *lhs, const Component *rhs) const
+ \fn QInstaller::Component::SortingPriorityLessThan::operator() (const Component *lhs, const Component *rhs) const
Returns \c true if \a lhs is less than \a rhs; otherwise returns \c false.
*/
/*!
\inmodule QtInstallerFramework
- \class Component::SortingPriorityGreaterThan
+ \class QInstaller::Component::SortingPriorityGreaterThan
\brief The SortingPriorityGreaterThan class sets a decreasing sorting priority for child
components.
@@ -114,7 +114,7 @@ static const QLatin1String scUnstable("Unstable");
*/
/*!
- \fn Component::SortingPriorityGreaterThan::operator() (const Component *lhs, const Component *rhs) const
+ \fn QInstaller::Component::SortingPriorityGreaterThan::operator() (const Component *lhs, const Component *rhs) const
Returns \c true if \a lhs is greater than \a rhs; otherwise returns \c false.
*/
@@ -126,20 +126,20 @@ static const QLatin1String scUnstable("Unstable");
*/
/*!
- \property Component::name
+ \property QInstaller::Component::name
\brief The name of the component as set in the \c <Name> tag of the package
information file.
*/
/*!
- \property Component::displayName
+ \property QInstaller::Component::displayName
\brief The name of the component as shown in the user interface.
*/
/*!
- \property Component::autoCreateOperations
+ \property QInstaller::Component::autoCreateOperations
\brief Whether some standard operations for the component should be
automatically created when the installation starts.
@@ -148,7 +148,7 @@ static const QLatin1String scUnstable("Unstable");
*/
/*!
- \property Component::archives
+ \property QInstaller::Component::archives
\brief The list of archive URLs registered for the component.
@@ -158,25 +158,25 @@ static const QLatin1String scUnstable("Unstable");
*/
/*!
- \property Component::dependencies
+ \property QInstaller::Component::dependencies
\brief The components this component depends on. This is a read-only property.
*/
/*!
- \property Component::autoDependencies
+ \property QInstaller::Component::autoDependencies
\brief The value of the \c <AutoDependOn> element in the package information file.
*/
/*!
- \property Component::fromOnlineRepository
+ \property QInstaller::Component::fromOnlineRepository
\brief Whether this component has been loaded from an online repository.
*/
/*!
- \property Component::repositoryUrl
+ \property QInstaller::Component::repositoryUrl
\brief The repository URL the component is downloaded from.
@@ -184,7 +184,7 @@ static const QLatin1String scUnstable("Unstable");
*/
/*!
- \property Component::default
+ \property QInstaller::Component::default
\brief Whether the component is a default one. This is a read-only property.
@@ -192,19 +192,19 @@ static const QLatin1String scUnstable("Unstable");
*/
/*!
- \property Component::installed
+ \property QInstaller::Component::installed
\brief Whether the component is installed. This is a read-only property.
*/
/*!
- \property Component::enabled
+ \property QInstaller::Component::enabled
\brief Whether the component is currently enabled. The property is both readable and writable.
*/
/*!
- \property Component::unstable
+ \property QInstaller::Component::unstable
\brief Whether the component is unstable. This is a read-only property.
@@ -212,13 +212,13 @@ static const QLatin1String scUnstable("Unstable");
*/
/*!
- \fn Component::loaded()
+ \fn QInstaller::Component::loaded()
\sa {component::loaded}{component.loaded}
*/
/*!
- \fn Component::valueChanged(const QString &key, const QString &value)
+ \fn QInstaller::Component::valueChanged(const QString &key, const QString &value)
Emitted when the value of the variable with the name \a key changes to \a value.
@@ -226,7 +226,7 @@ static const QLatin1String scUnstable("Unstable");
*/
/*!
- \fn Component::virtualStateChanged()
+ \fn QInstaller::Component::virtualStateChanged()
\sa {component::virtualStateChanged}{component.virtualStateChanged}
*/
@@ -690,7 +690,7 @@ void Component::loadLicenses(const QString &directory, const QHash<QString, QVar
/*!
- \property Component::userInterfaces
+ \property QInstaller::Component::userInterfaces
\brief A list of all user interface class names known to this component.
*/
diff --git a/src/libs/installer/fileutils.cpp b/src/libs/installer/fileutils.cpp
index c72a45c1e..20d1ed93e 100644
--- a/src/libs/installer/fileutils.cpp
+++ b/src/libs/installer/fileutils.cpp
@@ -254,7 +254,7 @@ public:
}
protected:
- /*!
+ /*
\reimp
*/
void run()
@@ -297,6 +297,8 @@ void QInstaller::removeSystemGeneratedFiles(const QString &path)
/*!
Sets permissions of file or directory specified by \a fileName to \c 644 or \c 755
based by the value of \a permissions.
+
+ Returns \c true on success, \c false otherwise.
*/
bool QInstaller::setDefaultFilePermissions(const QString &fileName, DefaultFilePermissions permissions)
{
diff --git a/src/libs/installer/lib7z_facade.cpp b/src/libs/installer/lib7z_facade.cpp
index ede0b1f62..c321052e3 100644
--- a/src/libs/installer/lib7z_facade.cpp
+++ b/src/libs/installer/lib7z_facade.cpp
@@ -255,7 +255,7 @@ QString errorMessageFrom7zResult(const LONG &extractResult)
return errorMessage;
}
-/*!
+/*
RAII class to create a directory (tryCreate()) and delete it on destruction unless released.
*/
struct DirectoryGuard
@@ -277,7 +277,7 @@ struct DirectoryGuard
qCWarning(QInstaller::lcInstallerInstallLog) << "Cannot delete directory " << m_path;
}
- /*!
+ /*
Tries to create the directory structure.
Returns a list of every directory created.
*/
@@ -931,7 +931,7 @@ HRESULT UpdateCallback::SetOperationResult(Int32)
return S_OK;
}
-/*!
+/*
Function to create an empty 7z container. Using a temporary file only is not working, since
7z checks the output file for a valid signature, otherwise it rejects overwriting the file.
*/
diff --git a/src/libs/installer/packagemanagercore.cpp b/src/libs/installer/packagemanagercore.cpp
index a67ecbf8e..e6b6de62b 100644
--- a/src/libs/installer/packagemanagercore.cpp
+++ b/src/libs/installer/packagemanagercore.cpp
@@ -143,31 +143,31 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::aboutCalculateComponentsToInstall() const
+ \fn QInstaller::PackageManagerCore::aboutCalculateComponentsToInstall() const
\sa {installer::aboutCalculateComponentsToInstall}{installer.aboutCalculateComponentsToInstall}
*/
/*!
- \fn PackageManagerCore::finishedCalculateComponentsToInstall() const
+ \fn QInstaller::PackageManagerCore::finishedCalculateComponentsToInstall() const
\sa {installer::finishedCalculateComponentsToInstall}{installer.finishedCalculateComponentsToInstall}
*/
/*!
- \fn PackageManagerCore::aboutCalculateComponentsToUninstall() const
+ \fn QInstaller::PackageManagerCore::aboutCalculateComponentsToUninstall() const
\sa {installer::aboutCalculateComponentsToUninstall}{installer.aboutCalculateComponentsToUninstall}
*/
/*!
- \fn PackageManagerCore::finishedCalculateComponentsToUninstall() const
+ \fn QInstaller::PackageManagerCore::finishedCalculateComponentsToUninstall() const
\sa {installer::finishedCalculateComponentsToUninstall}{installer.finishedCalculateComponentsToUninstall}
*/
/*!
- \fn PackageManagerCore::componentAdded(QInstaller::Component *comp)
+ \fn QInstaller::PackageManagerCore::componentAdded(QInstaller::Component *comp)
Emitted when the new root component \a comp is added.
@@ -176,7 +176,7 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::rootComponentsAdded(QList<QInstaller::Component*> components)
+ \fn QInstaller::PackageManagerCore::rootComponentsAdded(QList<QInstaller::Component*> components)
Emitted when the list of root components specified by \a components is added.
@@ -185,7 +185,7 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::updaterComponentsAdded(QList<QInstaller::Component*> components)
+ \fn QInstaller::PackageManagerCore::updaterComponentsAdded(QList<QInstaller::Component*> components)
Emitted when a new list of updater components specified by \a components is added.
@@ -194,7 +194,7 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::valueChanged(const QString &key, const QString &value)
+ \fn QInstaller::PackageManagerCore::valueChanged(const QString &key, const QString &value)
Emitted when the value \a value of the key \a key changes.
@@ -202,7 +202,7 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::currentPageChanged(int page)
+ \fn QInstaller::PackageManagerCore::currentPageChanged(int page)
Emitted when the current page \a page changes.
@@ -210,13 +210,13 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::finishButtonClicked()
+ \fn QInstaller::PackageManagerCore::finishButtonClicked()
\sa {installer::finishButtonClicked}{installer.finishButtonClicked}
*/
/*!
- \fn PackageManagerCore::metaJobProgress(int progress)
+ \fn QInstaller::PackageManagerCore::metaJobProgress(int progress)
Triggered with progress updates of the communication with a remote
repository. Values of \a progress range from 0 to 100.
@@ -225,7 +225,7 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::metaJobTotalProgress(int progress)
+ \fn QInstaller::PackageManagerCore::metaJobTotalProgress(int progress)
Triggered when the total \a progress value of the communication with a
remote repository changes.
@@ -234,7 +234,7 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::metaJobInfoMessage(const QString &message)
+ \fn QInstaller::PackageManagerCore::metaJobInfoMessage(const QString &message)
Triggered with informative updates, \a message, of the communication with a remote repository.
@@ -242,14 +242,14 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::startAllComponentsReset()
+ \fn QInstaller::PackageManagerCore::startAllComponentsReset()
\sa {installer::startAllComponentsReset}{installer.startAllComponentsReset}
\sa finishAllComponentsReset()
*/
/*!
- \fn PackageManagerCore::finishAllComponentsReset(const QList<QInstaller::Component*> &rootComponents)
+ \fn QInstaller::PackageManagerCore::finishAllComponentsReset(const QList<QInstaller::Component*> &rootComponents)
Triggered when the list of new root components, \a rootComponents, has been updated.
@@ -258,13 +258,13 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::startUpdaterComponentsReset()
+ \fn QInstaller::PackageManagerCore::startUpdaterComponentsReset()
\sa {installer::startUpdaterComponentsReset}{installer.startUpdaterComponentsReset}
*/
/*!
- \fn PackageManagerCore::finishUpdaterComponentsReset(const QList<QInstaller::Component*> &componentsWithUpdates)
+ \fn QInstaller::PackageManagerCore::finishUpdaterComponentsReset(const QList<QInstaller::Component*> &componentsWithUpdates)
Triggered when the list of available remote updates, \a componentsWithUpdates,
has been updated.
@@ -273,48 +273,48 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::installationStarted()
+ \fn QInstaller::PackageManagerCore::installationStarted()
- \sa {installer::installationStarted}{installer.installationStarted}
- \sa installationFinished() installationInterrupted()
+ \sa {installer::installationStarted}{installer.installationStarted},
+ installationFinished(), installationInterrupted()
*/
/*!
- \fn PackageManagerCore::installationInterrupted()
+ \fn QInstaller::PackageManagerCore::installationInterrupted()
- \sa {installer::installationInterrupted}{installer.installationInterrupted}
- \sa interrupt() installationStarted() installationFinished()
+ \sa {installer::installationInterrupted}{installer.installationInterrupted},
+ interrupt(), installationStarted(), installationFinished()
*/
/*!
- \fn PackageManagerCore::installationFinished()
+ \fn QInstaller::PackageManagerCore::installationFinished()
- \sa {installer::installationFinished}{installer.installationFinished}
- \sa installationStarted() installationInterrupted()
+ \sa {installer::installationFinished}{installer.installationFinished},
+ installationStarted(), installationInterrupted()
*/
/*!
- \fn PackageManagerCore::updateFinished()
+ \fn QInstaller::PackageManagerCore::updateFinished()
\sa {installer::installationFinished}{installer.installationFinished}
*/
/*!
- \fn PackageManagerCore::uninstallationStarted()
+ \fn QInstaller::PackageManagerCore::uninstallationStarted()
\sa {installer::uninstallationStarted}{installer.uninstallationStarted}
\sa uninstallationFinished()
*/
/*!
- \fn PackageManagerCore::uninstallationFinished()
+ \fn QInstaller::PackageManagerCore::uninstallationFinished()
\sa {installer::uninstallationFinished}{installer.uninstallationFinished}
\sa uninstallationStarted()
*/
/*!
- \fn PackageManagerCore::titleMessageChanged(const QString &title)
+ \fn QInstaller::PackageManagerCore::titleMessageChanged(const QString &title)
Emitted when the text of the installer status (on the PerformInstallation page) changes to
\a title.
@@ -323,7 +323,7 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::wizardPageInsertionRequested(QWidget *widget, QInstaller::PackageManagerCore::WizardPage page)
+ \fn QInstaller::PackageManagerCore::wizardPageInsertionRequested(QWidget *widget, QInstaller::PackageManagerCore::WizardPage page)
Emitted when a custom \a widget is about to be inserted into \a page by
addWizardPage().
@@ -332,7 +332,7 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::wizardPageRemovalRequested(QWidget *widget)
+ \fn QInstaller::PackageManagerCore::wizardPageRemovalRequested(QWidget *widget)
Emitted when a \a widget is removed by removeWizardPage().
@@ -340,7 +340,7 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::wizardWidgetInsertionRequested(QWidget *widget,
+ \fn QInstaller::PackageManagerCore::wizardWidgetInsertionRequested(QWidget *widget,
QInstaller::PackageManagerCore::WizardPage page, int position)
Emitted when a \a widget is inserted into \a page by addWizardPageItem(). If several widgets
@@ -350,7 +350,7 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::wizardWidgetRemovalRequested(QWidget *widget)
+ \fn QInstaller::PackageManagerCore::wizardWidgetRemovalRequested(QWidget *widget)
Emitted when a \a widget is removed by removeWizardPageItem().
@@ -358,7 +358,7 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::wizardPageVisibilityChangeRequested(bool visible, int page)
+ \fn QInstaller::PackageManagerCore::wizardPageVisibilityChangeRequested(bool visible, int page)
Emitted when the visibility of the page with the ID \a page changes to \a visible.
@@ -367,7 +367,7 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::setValidatorForCustomPageRequested(QInstaller::Component *component, const QString &name,
+ \fn QInstaller::PackageManagerCore::setValidatorForCustomPageRequested(QInstaller::Component *component, const QString &name,
const QString &callbackName)
Requests that a validator be set for the custom page specified by \a name and
@@ -378,7 +378,7 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::setAutomatedPageSwitchEnabled(bool request)
+ \fn QInstaller::PackageManagerCore::setAutomatedPageSwitchEnabled(bool request)
Triggered when the automatic switching from the perform installation to the installation
finished page is enabled (\a request is \c true) or disabled (\a request is \c false).
@@ -390,25 +390,25 @@ using namespace QInstaller;
*/
/*!
- \fn PackageManagerCore::coreNetworkSettingsChanged()
+ \fn QInstaller::PackageManagerCore::coreNetworkSettingsChanged()
\sa {installer::coreNetworkSettingsChanged}{installer.coreNetworkSettingsChanged}
*/
/*!
- \fn PackageManagerCore::guiObjectChanged(QObject *gui)
+ \fn QInstaller::PackageManagerCore::guiObjectChanged(QObject *gui)
Emitted when the GUI object is set to \a gui.
*/
/*!
- \fn PackageManagerCore::unstableComponentFound(const QString &type, const QString &errorMessage, const QString &component)
+ \fn QInstaller::PackageManagerCore::unstableComponentFound(const QString &type, const QString &errorMessage, const QString &component)
Emitted when an unstable \a component is found containing an unstable \a type and \a errorMessage.
*/
/*!
- \fn PackageManagerCore::installerBinaryMarkerChanged(qint64 magicMarker)
+ \fn QInstaller::PackageManagerCore::installerBinaryMarkerChanged(qint64 magicMarker)
Emitted when installer binary marker \a magicMarker has changed.
*/
@@ -476,7 +476,7 @@ void PackageManagerCore::writeMaintenanceConfigFiles()
}
/*!
- Disables writing of maintenance tool for the current session.
+ Disables writing of maintenance tool for the current session if \a disable is \c true.
*/
void PackageManagerCore::disableWriteMaintenanceTool(bool disable)
{
@@ -1129,7 +1129,9 @@ PackageManagerCore::PackageManagerCore()
/*!
Creates an installer or uninstaller and performs sanity checks on the operations specified
- by \a operations.
+ by \a operations. A hash table of variables to be stored as package manager core values
+ can be specified by \a params. Sets the current instance type to be either a GUI or CLI one based
+ on the value of \a commandLineInstance.
The magic marker \a magicmaker is a \c quint64 that identifies the type of the binary:
\c installer or \c uninstaller.
@@ -1586,7 +1588,7 @@ bool PackageManagerCore::fetchPackagesTree(const PackagesList &packages, const L
}
/*!
- \fn PackageManagerCore::addWizardPage(QInstaller::Component * component, const QString & name, int page)
+ \fn QInstaller::PackageManagerCore::addWizardPage(QInstaller::Component * component, const QString & name, int page)
Adds the widget with object name \a name registered by \a component as a new page
into the installer's GUI wizard. The widget is added before \a page.
@@ -1611,7 +1613,7 @@ bool PackageManagerCore::addWizardPage(Component *component, const QString &name
}
/*!
- \fn PackageManagerCore::removeWizardPage(QInstaller::Component * component, const QString & name)
+ \fn QInstaller::PackageManagerCore::removeWizardPage(QInstaller::Component * component, const QString & name)
Removes the widget with the object name \a name previously added to the installer's wizard
by \a component.
@@ -1651,7 +1653,7 @@ bool PackageManagerCore::setDefaultPageVisible(int page, bool visible)
}
/*!
- \fn PackageManagerCore::setValidatorForCustomPage(QInstaller::Component * component, const QString & name, const QString & callbackName)
+ \fn QInstaller::PackageManagerCore::setValidatorForCustomPage(QInstaller::Component * component, const QString & name, const QString & callbackName)
Sets a validator for the custom page specified by \a name and \a callbackName
for the component \a component.
@@ -1692,7 +1694,7 @@ void PackageManagerCore::deselectComponent(const QString &id)
}
/*!
- \fn PackageManagerCore::addWizardPageItem(QInstaller::Component * component, const QString & name,
+ \fn QInstaller::PackageManagerCore::addWizardPageItem(QInstaller::Component * component, const QString & name,
int page, int position)
Adds the widget with the object name \a name registered by \a component as a GUI element
@@ -1722,7 +1724,7 @@ bool PackageManagerCore::addWizardPageItem(Component *component, const QString &
}
/*!
- \fn PackageManagerCore::removeWizardPageItem(QInstaller::Component * component, const QString & name)
+ \fn QInstaller::PackageManagerCore::removeWizardPageItem(QInstaller::Component * component, const QString & name)
Removes the widget with the object name \a name previously added to the installer's wizard
by \a component.
diff --git a/src/libs/installer/packagemanagercore_p.cpp b/src/libs/installer/packagemanagercore_p.cpp
index 030b79701..c4a90e695 100644
--- a/src/libs/installer/packagemanagercore_p.cpp
+++ b/src/libs/installer/packagemanagercore_p.cpp
@@ -310,7 +310,7 @@ PackageManagerCorePrivate::~PackageManagerCorePrivate()
// delete m_gui;
}
-/*!
+/*
Return true, if a process with \a name is running. On Windows, comparison is case-insensitive.
*/
/* static */
diff --git a/src/libs/installer/packagemanagergui.cpp b/src/libs/installer/packagemanagergui.cpp
index d79c1762e..0ad9c90d3 100644
--- a/src/libs/installer/packagemanagergui.cpp
+++ b/src/libs/installer/packagemanagergui.cpp
@@ -252,41 +252,32 @@ public:
*/
/*!
- \fn void PackageManagerGui::interrupted()
+ \fn void QInstaller::PackageManagerGui::interrupted()
\sa {gui::interrupted}{gui.interrupted}
*/
/*!
- \fn void PackageManagerGui::languageChanged()
+ \fn void QInstaller::PackageManagerGui::languageChanged()
\sa {gui::languageChanged}{gui.languageChanged}
*/
/*!
- \fn void PackageManagerGui::finishButtonClicked()
+ \fn void QInstaller::PackageManagerGui::finishButtonClicked()
\sa {gui::finishButtonClicked}{gui.finishButtonClicked}
*/
/*!
- \fn void PackageManagerGui::gotRestarted()
+ \fn void QInstaller::PackageManagerGui::gotRestarted()
\sa {gui::gotRestarted}{gui.gotRestarted}
*/
/*!
- \fn void PackageManagerGui::settingsButtonClicked()
+ \fn void QInstaller::PackageManagerGui::settingsButtonClicked()
\sa {gui::settingsButtonClicked}{gui.settingsButtonClicked}
*/
/*!
- \fn void PackageManagerGui::setValidatorForCustomPageRequested(QInstaller::Component *component,
- const QString &name,
- const QString &callbackName)
-
- Sets a validator for the custom page specified by \a name and
- \a callbackName requested by \a component.
-*/
-
-/*!
- \fn void PackageManagerGui::packageManagerCore() const
+ \fn void QInstaller::PackageManagerGui::packageManagerCore() const
Returns the package manager core.
*/
@@ -1118,55 +1109,49 @@ void PackageManagerGui::currentPageChanged(int newId)
*/
/*!
- \fn PackageManagerPage::~PackageManagerPage()
+ \fn QInstaller::PackageManagerPage::~PackageManagerPage()
Destructs a package manager page.
*/
/*!
- \fn PackageManagerPage::gui() const
+ \fn QInstaller::PackageManagerPage::gui() const
Returns the wizard this page belongs to.
*/
/*!
- \fn PackageManagerPage::isInterruptible() const
+ \fn QInstaller::PackageManagerPage::isInterruptible() const
Returns \c true if the installation can be interrupted.
*/
/*!
- \fn PackageManagerPage::setValidatePageComponent(QInstaller::Component *component)
-
- Sets \a component as the component that validates the page.
-*/
-
-/*!
- \fn PackageManagerPage::settingsButtonRequested() const
+ \fn QInstaller::PackageManagerPage::settingsButtonRequested() const
Returns \c true if the page requests the wizard to show the \uicontrol Settings button.
*/
/*!
- \fn PackageManagerPage::setSettingsButtonRequested(bool request)
+ \fn QInstaller::PackageManagerPage::setSettingsButtonRequested(bool request)
Determines that the page should request the \uicontrol Settings button if \a request is \c true.
*/
/*!
- \fn PackageManagerPage::entered()
+ \fn QInstaller::PackageManagerPage::entered()
This signal is called when a page is entered.
*/
/*!
- \fn PackageManagerPage::left()
+ \fn QInstaller::PackageManagerPage::left()
This signal is called when a page is left.
*/
/*!
- \fn PackageManagerPage::entering()
+ \fn QInstaller::PackageManagerPage::entering()
Called when end users enter the page and the PackageManagerGui:currentPageChanged()
signal is triggered. Supports the QWizardPage::​initializePage() function to ensure
@@ -1176,13 +1161,13 @@ void PackageManagerGui::currentPageChanged(int newId)
*/
/*!
- \fn PackageManagerPage::showOnPageListChanged()
+ \fn QInstaller::PackageManagerPage::showOnPageListChanged()
Called when page visibility on page list has changed and refresh is needed.
*/
/*!
- \fn PackageManagerPage::leaving()
+ \fn QInstaller::PackageManagerPage::leaving()
Called when end users leave the page and the PackageManagerGui:currentPageChanged()
signal is triggered.
@@ -1447,7 +1432,7 @@ int PackageManagerPage::nextId() const
*/
/*!
- \fn IntroductionPage::packageManagerCoreTypeChanged()
+ \fn QInstaller::IntroductionPage::packageManagerCoreTypeChanged()
This signal is emitted when the package manager core type changes.
*/
@@ -2368,7 +2353,7 @@ void TargetDirectoryPage::initializePage()
}
/*!
- Checks whether the target directory exists and has correct content.
+ Returns \c true if the target directory exists and has correct content.
*/
bool TargetDirectoryPage::validatePage()
{
@@ -2643,13 +2628,13 @@ void ReadyForInstallationPage::updatePageListTitle()
*/
/*!
- \fn PerformInstallationPage::isInterruptible() const
+ \fn QInstaller::PerformInstallationPage::isInterruptible() const
Returns \c true if the installation can be interrupted.
*/
/*!
- \fn PerformInstallationPage::setAutomatedPageSwitchEnabled(bool request)
+ \fn QInstaller::PerformInstallationPage::setAutomatedPageSwitchEnabled(bool request)
Enables automatic switching of pages when \a request is \c true.
*/
@@ -3029,7 +3014,7 @@ void FinishedPage::cleanupChangedConnects()
*/
/*!
- \fn RestartPage::restart()
+ \fn QInstaller::RestartPage::restart()
This signal is emitted when the installer is restarted.
*/
diff --git a/src/libs/installer/performinstallationform.cpp b/src/libs/installer/performinstallationform.cpp
index 28e2e1f45..f60ef0ab1 100644
--- a/src/libs/installer/performinstallationform.cpp
+++ b/src/libs/installer/performinstallationform.cpp
@@ -68,7 +68,7 @@ using namespace QInstaller;
*/
/*!
- \fn PerformInstallationForm::showDetailsChanged()
+ \fn QInstaller::PerformInstallationForm::showDetailsChanged()
This signal is emitted when the end users select the details button to show
or hide progress details.
diff --git a/src/libs/installer/remotefileengine.cpp b/src/libs/installer/remotefileengine.cpp
index 3c54d1e29..ae7c5c992 100644
--- a/src/libs/installer/remotefileengine.cpp
+++ b/src/libs/installer/remotefileengine.cpp
@@ -35,7 +35,6 @@
namespace QInstaller {
-
// -- RemoteFileEngineHandler
QAbstractFileEngine* RemoteFileEngineHandler::create(const QString &fileName) const
@@ -80,7 +79,7 @@ private:
QStringList entries;
};
-/*!
+/*
Advances the iterator to the next entry, and returns the current file path of this new
entry. If hasNext() returns \c false, the function does nothing and returns an empty QString.
*/
@@ -89,7 +88,7 @@ bool RemoteFileEngineIterator::hasNext() const
return index < entries.size() - 1;
}
-/*!
+/*
Returns \c true if there is at least one more entry in the directory, otherwise returns
\c false.
*/
@@ -101,7 +100,7 @@ QString RemoteFileEngineIterator::next()
return currentFilePath();
}
-/*!
+/*
Returns the name of the current directory entry, excluding the path.
*/
QString RemoteFileEngineIterator::currentFileName() const
@@ -110,8 +109,10 @@ QString RemoteFileEngineIterator::currentFileName() const
}
-// -- RemoteFileEngine
-
+/*!
+ \class QInstaller::RemoteFileEngine
+ \inmodule QtInstallerFramework
+*/
RemoteFileEngine::RemoteFileEngine()
: RemoteObject(QLatin1String(Protocol::QAbstractFileEngine))
{
@@ -122,7 +123,6 @@ RemoteFileEngine::~RemoteFileEngine()
}
/*!
- \reimp
*/
bool RemoteFileEngine::atEnd() const
{
@@ -197,7 +197,6 @@ QStringList RemoteFileEngine::entryList(QDir::Filters filters, const QStringList
}
/*!
- \reimp
*/
QFile::FileError RemoteFileEngine::error() const
{
@@ -209,7 +208,6 @@ QFile::FileError RemoteFileEngine::error() const
}
/*!
- \reimp
*/
QString RemoteFileEngine::errorString() const
{
diff --git a/src/libs/installer/repository.cpp b/src/libs/installer/repository.cpp
index e186073ce..47e985eb2 100644
--- a/src/libs/installer/repository.cpp
+++ b/src/libs/installer/repository.cpp
@@ -120,7 +120,7 @@ bool Repository::isDefault() const
}
/*!
- Returns the URL of the repository. By default an invalid \sa QUrl is returned.
+ Returns the URL of the repository. By default an invalid QUrl is returned.
*/
QUrl Repository::url() const
{
diff --git a/src/libs/installer/scriptengine.cpp b/src/libs/installer/scriptengine.cpp
index 55940df61..d4ee63bdc 100644
--- a/src/libs/installer/scriptengine.cpp
+++ b/src/libs/installer/scriptengine.cpp
@@ -46,7 +46,7 @@ namespace QInstaller {
*/
/*!
- \fn ScriptEngine::globalObject() const
+ \fn QInstaller::ScriptEngine::globalObject() const
Returns a global object.
*/
diff --git a/src/libs/installer/utils.cpp b/src/libs/installer/utils.cpp
index db6dcadec..7961147b0 100644
--- a/src/libs/installer/utils.cpp
+++ b/src/libs/installer/utils.cpp
@@ -74,7 +74,7 @@ void QInstaller::uiDetachedWait(int ms)
The process will be started in the directory \a workingDirectory.
- If the function is successful then \a *pid is set to the process identifier of the started
+ If the function is successful then \a pid is set to the process identifier of the started
process.
Additional note: The difference in using this function over its equivalent from QProcess