summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKatja Marttila <katja.marttila@qt.io>2019-12-02 13:31:27 +0200
committerKatja Marttila <katja.marttila@qt.io>2019-12-17 06:43:31 +0000
commiteca45594967aba89c124a8b88ee8917b35d76181 (patch)
tree4396223e2ae389c986188cf4942ee07a606fb877
parent4744ad130a2d4310e812a89da22d36a2e885b281 (diff)
Documentation fixes
Change-Id: Ibffb5470d374c8d612791f48c951deddd00f3121 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
-rw-r--r--doc/config/ifw.qdocconf4
-rw-r--r--doc/scripting-api/component.qdoc8
-rw-r--r--doc/scripting-api/packagemanagercore.qdoc13
-rw-r--r--src/libs/installer/abstractfiletask.cpp8
-rw-r--r--src/libs/installer/component.cpp47
-rw-r--r--src/libs/installer/component.h10
-rw-r--r--src/libs/installer/installercalculator.cpp2
-rw-r--r--src/libs/installer/lib7z_create.h4
-rw-r--r--src/libs/installer/lib7z_facade.cpp99
-rw-r--r--src/libs/installer/lib7z_list.h1
-rw-r--r--src/libs/installer/packagemanagercore.cpp50
-rw-r--r--src/libs/installer/packagemanagercore.h8
-rw-r--r--src/libs/installer/packagemanagergui.cpp20
-rw-r--r--src/libs/installer/repositorycategory.cpp6
-rw-r--r--src/libs/installer/repositorycategory.h6
-rw-r--r--src/libs/kdtools/filedownloader.cpp20
-rw-r--r--src/libs/kdtools/localpackagehub.cpp3
-rw-r--r--tools/archivegen/archive.cpp2
-rw-r--r--tools/common/repositorygen.cpp6
19 files changed, 278 insertions, 39 deletions
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
@@ -359,6 +359,14 @@
*/
/*!
+ \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()
Set's the components state to installed.
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
@@ -124,6 +124,13 @@
*/
/*!
+ \qmlsignal installer::metaJobTotalProgress(int progress)
+
+ Triggered when total 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.
@@ -285,6 +292,12 @@
*/
/*!
+ \qmlmethod void installer::clearComponentsToInstallCalculated()
+
+ Forces a recalculation of components to install.
+*/
+
+/*!
\qmlmethod void installer::autoAcceptMessageBoxes()
Automatically accept all user message boxes.
diff --git a/src/libs/installer/abstractfiletask.cpp b/src/libs/installer/abstractfiletask.cpp
index ada54e598..83345db05 100644
--- a/src/libs/installer/abstractfiletask.cpp
+++ b/src/libs/installer/abstractfiletask.cpp
@@ -50,6 +50,8 @@ namespace QInstaller {
\value TaskItem
\value SourceFile
\value TargetFile
+ \value Name
+ \value ChecksumMismatch
\value UserRole The first role that can be used for user-specific purposes.
*/
@@ -128,6 +130,12 @@ namespace QInstaller {
*/
/*!
+ \fn FileTaskResult::checksumMismatch() const
+
+ Returns \c true if checksum mismatch is detected otherwise returns \c false.
+*/
+
+/*!
Constructs an empty abstract file task object.
*/
AbstractFileTask::AbstractFileTask()
diff --git a/src/libs/installer/component.cpp b/src/libs/installer/component.cpp
index cd40d4a7b..e8abe2383 100644
--- a/src/libs/installer/component.cpp
+++ b/src/libs/installer/component.cpp
@@ -70,6 +70,21 @@ static const QLatin1String scExpandedByDefault("ExpandedByDefault");
static const QLatin1String scUnstable("Unstable");
/*!
+ \enum Component::UnstableError
+
+ This enum type holds the component unstable error reason:
+
+ \value DepencyToUnstable
+ Component has a dependency to an unstable component.
+ \value ShaMismatch
+ Component has packages with non-matching SHA values.
+ \value ScriptLoadingFailed
+ Component script has errors or loading fails.
+ \value MissingDependency
+ Component has dependencies to missing components.
+*/
+
+/*!
\inmodule QtInstallerFramework
\class Component::SortingPriorityLessThan
\brief The SortingPriorityLessThan class sets an increasing sorting order for child components.
@@ -185,6 +200,14 @@ static const QLatin1String scUnstable("Unstable");
*/
/*!
+ \property Component::unstable
+
+ \brief Whether the component is unstable. This is a read-only property.
+
+ \note Unstable components cannot be selected for installation.
+*/
+
+/*!
\fn Component::loaded()
\sa {component::loaded}{component.loaded}
@@ -524,12 +547,12 @@ void Component::loadComponentScript(const QString &fileName)
Component *dependencyComponent = packageManagerCore()->componentByName
(PackageManagerCore::checkableName(dependency));
if (dependencyComponent && dependencyComponent->isUnstable())
- setUnstable(PackageManagerCore::UnstableError::DepencyToUnstable, QLatin1String("Dependent on unstable component"));
+ setUnstable(Component::UnstableError::DepencyToUnstable, QLatin1String("Dependent on unstable component"));
}
}
} catch (const Error &error) {
if (packageManagerCore()->settings().allowUnstableComponents()) {
- setUnstable(PackageManagerCore::UnstableError::ScriptLoadingFailed, error.message());
+ setUnstable(Component::Component::ScriptLoadingFailed, error.message());
qWarning() << error.message();
} else {
throw error;
@@ -1090,6 +1113,8 @@ bool Component::addOperation(QQmlV4Function *func)
The variables that the parameters contain, such as \c @TargetDir@, are replaced with their
values.
+ Returns \c true if the operation is created; otherwise returns \c false.
+
\sa {component::addOperation}{component.addOperation}
*/
bool Component::addOperation(const QString &operation, const QStringList &parameters)
@@ -1118,6 +1143,8 @@ bool Component::addElevatedOperation(QQmlV4Function *func)
The variables that the parameters contain, such as \c @TargetDir@, are replaced with their
values. The operation is executed with elevated rights.
+ Returns \c true if the operation is created; otherwise returns \c false.
+
\sa {component::addElevatedOperation}{component.addElevatedOperation}
*/
bool Component::addElevatedOperation(const QString &operation, const QStringList &parameters)
@@ -1135,6 +1162,8 @@ bool Component::addElevatedOperation(const QString &operation, const QStringList
would be done by calling createOperations(). If you set this to \c false, it is completely up
to the component's script to create all operations.
+ Returns \c false when component's script will create all operations; otherwise returns \c true.
+
\sa {component::autoCreateOperations}{component.autoCreateOperations}
*/
bool Component::autoCreateOperations() const
@@ -1215,7 +1244,7 @@ QStringList Component::dependencies() const
Adds the component specified by \a newDependOn to the automatic depend-on list.
\sa {component::addAutoDependOn}{component.addAutoDependOn}
- \sa dependencies
+ \sa autoDependencies
*/
void Component::addAutoDependOn(const QString &newDependOn)
@@ -1387,12 +1416,20 @@ bool Component::isUninstalled() const
return scUninstalled == d->m_vars.value(scCurrentState);
}
+/*!
+ Returns \c true if this component is unstable.
+*/
+
bool Component::isUnstable() const
{
return scTrue == d->m_vars.value(scUnstable);
}
-void Component::setUnstable(PackageManagerCore::UnstableError error, const QString &errorMessage)
+/*!
+ Sets this component, all its child components and all the components depending on
+ this component unstable with the error code \a error and message \a errorMessage.
+*/
+void Component::setUnstable(Component::UnstableError error, const QString &errorMessage)
{
QList<Component*> dependencies = d->m_core->dependees(this);
// Mark this component unstable
@@ -1410,7 +1447,7 @@ void Component::setUnstable(PackageManagerCore::UnstableError error, const QStri
foreach (Component *descendant, this->descendantComponents()) {
descendant->markComponentUnstable();
}
- QMetaEnum metaEnum = QMetaEnum::fromType<PackageManagerCore::UnstableError>();
+ QMetaEnum metaEnum = QMetaEnum::fromType<Component::UnstableError>();
emit packageManagerCore()->unstableComponentFound(QLatin1String(metaEnum.valueToKey(error)), errorMessage, this->name());
}
diff --git a/src/libs/installer/component.h b/src/libs/installer/component.h
index e6bc4874d..6dafd61b2 100644
--- a/src/libs/installer/component.h
+++ b/src/libs/installer/component.h
@@ -67,6 +67,14 @@ public:
explicit Component(PackageManagerCore *core);
~Component();
+ enum UnstableError {
+ DepencyToUnstable = 0,
+ ShaMismatch,
+ ScriptLoadingFailed,
+ MissingDependency
+ };
+ Q_ENUM(UnstableError)
+
struct SortingPriorityLessThan
{
bool operator() (const Component *lhs, const Component *rhs) const
@@ -183,7 +191,7 @@ public:
Q_INVOKABLE bool componentChangeRequested();
bool isUnstable() const;
- void setUnstable(PackageManagerCore::UnstableError error, const QString &errorMessage = QString());
+ void setUnstable(Component::UnstableError error, const QString &errorMessage = QString());
bool isVirtual() const;
bool isSelected() const;
diff --git a/src/libs/installer/installercalculator.cpp b/src/libs/installer/installercalculator.cpp
index db1f88563..d381cfa9a 100644
--- a/src/libs/installer/installercalculator.cpp
+++ b/src/libs/installer/installercalculator.cpp
@@ -171,7 +171,7 @@ bool InstallerCalculator::appendComponentToInstall(Component *component, const Q
qWarning().noquote() << errorMessage;
m_componentsToInstallError.append(errorMessage);
if (component->packageManagerCore()->settings().allowUnstableComponents()) {
- component->setUnstable(PackageManagerCore::UnstableError::MissingDependency, errorMessage);
+ component->setUnstable(Component::UnstableError::MissingDependency, errorMessage);
continue;
} else {
return false;
diff --git a/src/libs/installer/lib7z_create.h b/src/libs/installer/lib7z_create.h
index ad308ffd1..bc61db7ab 100644
--- a/src/libs/installer/lib7z_create.h
+++ b/src/libs/installer/lib7z_create.h
@@ -41,7 +41,7 @@ QT_END_NAMESPACE
namespace Lib7z
{
- enum struct QTmpFile {
+ enum struct TmpFile {
No,
Yes
};
@@ -70,7 +70,7 @@ namespace Lib7z
void INSTALLER_EXPORT createArchive(QFileDevice *archive, const QStringList &sources,
Compression level = Compression::Normal, UpdateCallback *callback = 0);
void INSTALLER_EXPORT createArchive(const QString &archive, const QStringList &sources,
- QTmpFile mode, Compression level = Compression::Normal, UpdateCallback *callback = 0);
+ TmpFile mode, Compression level = Compression::Normal, UpdateCallback *callback = 0);
} // namespace Lib7z
diff --git a/src/libs/installer/lib7z_facade.cpp b/src/libs/installer/lib7z_facade.cpp
index b3b3319e8..1869c964f 100644
--- a/src/libs/installer/lib7z_facade.cpp
+++ b/src/libs/installer/lib7z_facade.cpp
@@ -114,6 +114,47 @@ void registerCodecByteSwap();
namespace Lib7z {
+/*!
+ \fn void Lib7z::PercentPrinter::PrintRatio()
+
+ Prints ratio.
+*/
+
+/*!
+ \fn void Lib7z::PercentPrinter::ClosePrint()
+
+ Closes print.
+*/
+
+/*!
+ \fn void Lib7z::PercentPrinter::RePrintRatio()
+
+ Reprints ratio.
+*/
+
+/*!
+ \fn void Lib7z::PercentPrinter::PrintNewLine()
+
+ Prints new line.
+*/
+
+/*!
+ \fn void Lib7z::PercentPrinter::PrintString(const char *s)
+
+ Prints string \a s.
+*/
+
+/*!
+ \fn void Lib7z::PercentPrinter::PrintString(const wchar_t *s)
+
+ Prints string \a s.
+*/
+
+/*!
+ \fn bool Lib7z::operator==(const File &lhs, const File &rhs);
+
+ Returns \c true if \a lhs and \a rhs are equal; otherwise returns \c false.
+*/
// -- 7z init codecs, archives
@@ -732,6 +773,30 @@ STDMETHODIMP ExtractCallback::SetOperationResult(Int32 /*resultEOperationResult*
}
/*!
+ \enum Lib7z::TmpFile
+
+ This enum type holds the temp file mode:
+
+ \value No
+ File is not a temporary file.
+ \value Yes
+ File is a tmp file.
+*/
+
+/*!
+ \enum Lib7z::Compression
+
+ This enum specifies the compression ratio of an archive:
+
+ \value Non
+ \value Fastest
+ \value Fast
+ \value Normal
+ \value Maximum
+ \value Ultra
+*/
+
+/*!
\namespace Lib7z
\inmodule QtInstallerFramework
\brief The Lib7z namespace contains miscellaneous identifiers used throughout the Lib7z library.
@@ -745,6 +810,30 @@ STDMETHODIMP ExtractCallback::SetOperationResult(Int32 /*resultEOperationResult*
is returned, the extraction will be aborted. The default implementation returns \c true.
*/
+/*!
+ \fn bool Lib7z::ExtractCallback::setArchive(CArc *carc)
+
+ Sets \a carc as archive.
+*/
+
+/*!
+ \fn void Lib7z::ExtractCallback::setTarget(const QString &dir)
+
+ Sets the target directory to \a dir.
+*/
+
+/*!
+ \fn void Lib7z::ExtractCallback::setCurrentFile(const QString &filename)
+
+ Sets the current file to \a filename.
+*/
+
+/*!
+ \fn virtual Lib7z::ExtractCallback::setCompleted(quint64 completed, quint64 total)
+
+ Returns completed. Always returns true. \a completed and \a total are unused.
+*/
+
// -- UpdateCallback
@@ -877,7 +966,7 @@ void INSTALLER_EXPORT createArchive(QFileDevice *archive, const QStringList &sou
LIB7Z_ASSERTS(archive, Writable)
const QString tmpArchive = createTmp7z();
- Lib7z::createArchive(tmpArchive, sources, QTmpFile::No, level, callback);
+ Lib7z::createArchive(tmpArchive, sources, TmpFile::No, level, callback);
try {
QFile source(tmpArchive);
@@ -892,7 +981,7 @@ void INSTALLER_EXPORT createArchive(QFileDevice *archive, const QStringList &sou
Creates an archive with the given filename \a archive. \a sourcePaths can contain one or more
files, one or more directories or a combination of files and folders. Also the \c * wildcard
is supported. To be able to use the function during an elevated installation, set \a mode to
- \c QTmpFile::Yes. The value of \a level specifies the compression ratio, the default is set
+ \c TmpFile::Yes. The value of \a level specifies the compression ratio, the default is set
to \c 5 (Normal compression). The \a callback can be used to get information about the archive
creation process. If no \a callback is given, an empty implementation is used.
@@ -901,12 +990,12 @@ void INSTALLER_EXPORT createArchive(QFileDevice *archive, const QStringList &sou
\note Filenames are stored case-sensitive with UTF-8 encoding.
\note The ownership of \a callback is transferred to the function and gets delete on exit.
*/
-void createArchive(const QString &archive, const QStringList &sources, QTmpFile mode,
+void createArchive(const QString &archive, const QStringList &sources, TmpFile mode,
Compression level, UpdateCallback *callback)
{
try {
QString target = archive;
- if (mode == QTmpFile::Yes)
+ if (mode == TmpFile::Yes)
target = createTmp7z();
CArcCmdLineOptions options;
@@ -959,7 +1048,7 @@ void createArchive(const QString &archive, const QStringList &sources, QTmpFile
throw SevenZipException(errorMsg);
}
- if (mode == QTmpFile::Yes) {
+ if (mode == TmpFile::Yes) {
QFile org(archive);
if (org.exists() && !org.remove()) {
throw SevenZipException(QCoreApplication::translate("Lib7z", "Cannot remove "
diff --git a/src/libs/installer/lib7z_list.h b/src/libs/installer/lib7z_list.h
index 6e2646025..8522877c1 100644
--- a/src/libs/installer/lib7z_list.h
+++ b/src/libs/installer/lib7z_list.h
@@ -53,6 +53,7 @@ namespace Lib7z
quint64 uncompressedSize = 0;
QFile::Permissions permissions = 0;
};
+
INSTALLER_EXPORT bool operator==(const File &lhs, const File &rhs);
QVector<File> INSTALLER_EXPORT listArchive(QFileDevice *archive);
diff --git a/src/libs/installer/packagemanagercore.cpp b/src/libs/installer/packagemanagercore.cpp
index d3d3b5be7..392dfb7b0 100644
--- a/src/libs/installer/packagemanagercore.cpp
+++ b/src/libs/installer/packagemanagercore.cpp
@@ -224,6 +224,15 @@ using namespace QInstaller;
*/
/*!
+ \fn PackageManagerCore::metaJobTotalProgress(int progress)
+
+ Triggered when the total \a progress value of the communication with a
+ remote repository changes.
+
+ \sa {installer::metaJobTotalProgress}{installer.metaJobTotalProgress}
+*/
+
+/*!
\fn PackageManagerCore::metaJobInfoMessage(const QString &message)
Triggered with informative updates, \a message, of the communication with a remote repository.
@@ -389,6 +398,12 @@ using namespace QInstaller;
Emitted when the GUI object is set to \a gui.
*/
+/*!
+ \fn 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.
+*/
+
Q_GLOBAL_STATIC(QMutex, globalModelMutex);
@@ -537,6 +552,7 @@ void PackageManagerCore::componentsToInstallNeedsRecalculation()
}
/*!
+ Forces a recalculation of components to install.
\sa {installer::clearComponentsToInstallCalculated}{installer.clearComponentsToInstallCalculated}
*/
void PackageManagerCore::clearComponentsToInstallCalculated()
@@ -1415,7 +1431,8 @@ void PackageManagerCore::addUserRepositories(const QStringList &repositories)
/*!
Sets additional \a repositories for this instance of the installer or updater
- if \a replace is \c false. Will be removed after invoking it again.
+ if \a replace is \c false. \a compressed repositories can be added as well.
+ Will be removed after invoking it again.
\sa {installer::setTemporaryRepositories}{installer.setTemporaryRepositories}
\sa addUserRepositories()
@@ -1655,6 +1672,11 @@ QList<Component*> PackageManagerCore::orderedComponentsToInstall() const
return d->installerCalculator()->orderedComponentsToInstall();
}
+/*!
+ Calculates components to install and uninstall. In case of an error, returns \c false
+ and and sets the \a displayString for error detail.
+*/
+
bool PackageManagerCore::calculateComponents(QString *displayString)
{
QString htmlOutput;
@@ -1823,6 +1845,10 @@ ComponentModel *PackageManagerCore::updaterComponentModel() const
return d->m_updaterModel;
}
+/*!
+ Updates all components silently without user interaction. In case there is an
+ essential update available, only the essential component will be updated.
+*/
void PackageManagerCore::updateComponentsSilently()
{
//Check if there are processes running in the install
@@ -2605,7 +2631,7 @@ bool PackageManagerCore::updateComponentData(struct Data &data, Component *compo
foreach (const QString packageName, d->m_metadataJob.shaMismatchPackages()) {
if (packageName == component->name()) {
QString errorString = QLatin1String("SHA mismatch detected for component ") + packageName;
- component->setUnstable(PackageManagerCore::UnstableError::ShaMismatch, errorString);
+ component->setUnstable(Component::UnstableError::ShaMismatch, errorString);
}
}
}
@@ -2979,16 +3005,26 @@ ComponentModel *PackageManagerCore::componentModel(PackageManagerCore *core, con
return model;
}
+/*!
+ Returns the file list used for delayed deletion.
+*/
QStringList PackageManagerCore::filesForDelayedDeletion() const
{
return d->m_filesForDelayedDeletion;
}
+/*!
+ Adds \a files for delayed deletion.
+*/
void PackageManagerCore::addFilesForDelayedDeletion(const QStringList &files)
{
d->m_filesForDelayedDeletion.append(files);
}
+/*!
+ Adds a colon symbol to the component \c name as a separator between
+ component \a name and version.
+*/
QString PackageManagerCore::checkableName(const QString &name)
{
// to ensure backward compatibility, fix component name with dash (-) symbol
@@ -2999,6 +3035,10 @@ QString PackageManagerCore::checkableName(const QString &name)
return name;
}
+/*!
+ Parses \a name and \a version from \a requirement component. \c requirement
+ contains both \a name and \a version separated either with ':' or with '-'.
+*/
void PackageManagerCore::parseNameAndVersion(const QString &requirement, QString *name, QString *version)
{
if (requirement.isEmpty()) {
@@ -3026,6 +3066,12 @@ void PackageManagerCore::parseNameAndVersion(const QString &requirement, QString
}
}
+/*!
+ Excludes version numbers from names from \a requirements components.
+ \a requirements list contains names that have both name and version.
+
+ Returns a list containing names without version numbers.
+*/
QStringList PackageManagerCore::parseNames(const QStringList &requirements)
{
QString name;
diff --git a/src/libs/installer/packagemanagercore.h b/src/libs/installer/packagemanagercore.h
index fd74a6cf7..0fe946caf 100644
--- a/src/libs/installer/packagemanagercore.h
+++ b/src/libs/installer/packagemanagercore.h
@@ -65,14 +65,6 @@ public:
Protocol::Mode mode = Protocol::Mode::Production);
~PackageManagerCore();
- enum UnstableError {
- DepencyToUnstable = 0,
- ShaMismatch,
- ScriptLoadingFailed,
- MissingDependency
- };
- Q_ENUM(UnstableError)
-
// status
enum Status {
Success = EXIT_SUCCESS,
diff --git a/src/libs/installer/packagemanagergui.cpp b/src/libs/installer/packagemanagergui.cpp
index 934570ae1..837e44c56 100644
--- a/src/libs/installer/packagemanagergui.cpp
+++ b/src/libs/installer/packagemanagergui.cpp
@@ -389,10 +389,14 @@ PackageManagerGui::PackageManagerGui(PackageManagerCore *core, QWidget *parent)
QTimer::singleShot(30, this, SLOT(setMaxSize()));
}
+/*!
+ Limits installer maximum size to screen size.
+*/
void PackageManagerGui::setMaxSize()
{
setMaximumSize(qApp->desktop()->availableGeometry(this).size());
}
+
/*!
Destructs a package manager UI.
*/
@@ -1528,7 +1532,7 @@ void IntroductionPage::onProgressChanged(int progress)
}
/*!
- Sets total \a progress value to progress bar.
+ Sets total \a totalProgress value to progress bar.
*/
void IntroductionPage::setTotalProgress(int totalProgress)
{
@@ -1927,6 +1931,10 @@ void ComponentSelectionPage::entering()
d->showCompressedRepositoryButton();
}
+/*!
+ Called when end users leave the page and the PackageManagerGui:currentPageChanged()
+ signal is triggered.
+*/
void ComponentSelectionPage::leaving()
{
d->hideCompressedRepositoryButton();
@@ -1993,11 +2001,21 @@ void ComponentSelectionPage::deselectComponent(const QString &id)
d->m_currentModel->setData(idx, Qt::Unchecked, Qt::CheckStateRole);
}
+/*!
+ Adds the possibility to install a compressed repository on component selection
+ page. A new button which opens a file browser is added for compressed
+ repository selection.
+*/
void ComponentSelectionPage::allowCompressedRepositoryInstall()
{
d->allowCompressedRepositoryInstall();
}
+/*!
+ Adds an additional virtual component with the \a name to be installed.
+
+ Returns \c true if the virtual component is found and not installed.
+*/
bool ComponentSelectionPage::addVirtualComponentToUninstall(const QString &name)
{
PackageManagerCore *core = packageManagerCore();
diff --git a/src/libs/installer/repositorycategory.cpp b/src/libs/installer/repositorycategory.cpp
index ce06480c8..79b1cc6a8 100644
--- a/src/libs/installer/repositorycategory.cpp
+++ b/src/libs/installer/repositorycategory.cpp
@@ -88,11 +88,17 @@ void RepositoryCategory::setDisplayName(const QString &displayname)
m_displayname = displayname;
}
+/*!
+ Returns the Tooltip for the category to be displayed.
+*/
QString RepositoryCategory::tooltip() const
{
return m_tooltip;
}
+/*!
+ Sets the Tooltip of the category to \a tooltip.
+*/
void RepositoryCategory::setTooltip(const QString &tooltip)
{
m_tooltip = tooltip;
diff --git a/src/libs/installer/repositorycategory.h b/src/libs/installer/repositorycategory.h
index 1996103a5..faa8d252b 100644
--- a/src/libs/installer/repositorycategory.h
+++ b/src/libs/installer/repositorycategory.h
@@ -26,8 +26,8 @@
**
**************************************************************************/
-#ifndef ARCHIVEREPOSITORY_H
-#define ARCHIVEREPOSITORY_H
+#ifndef REPOSITORYCATEGORY_H
+#define REPOSITORYCATEGORY_H
#include "installer_global.h"
#include "repository.h"
@@ -87,4 +87,4 @@ INSTALLER_EXPORT QDataStream &operator<<(QDataStream &ostream, const RepositoryC
Q_DECLARE_METATYPE(QInstaller::RepositoryCategory)
-#endif // ARCHIVEREPOSITORY_H
+#endif // REPOSITORYCATEGORY_H
diff --git a/src/libs/kdtools/filedownloader.cpp b/src/libs/kdtools/filedownloader.cpp
index fce1a6208..f12b6df5d 100644
--- a/src/libs/kdtools/filedownloader.cpp
+++ b/src/libs/kdtools/filedownloader.cpp
@@ -148,6 +148,16 @@ static double calcProgress(qint64 done, qint64 total)
*/
/*!
+ \fn FileDownloader::downloadCompleted()
+ This signal is emitted when downloading a file ends.
+*/
+
+/*!
+ \fn FileDownloader::downloadAborted(const QString &errorMessage)
+ This signal is emitted when downloading a file is aborted with \a errorMessage.
+*/
+
+/*!
\fn FileDownloader::estimatedDownloadTime(int seconds)
This signal is emitted with the estimated download time in \a seconds.
*/
@@ -424,7 +434,7 @@ void KDUpdater::FileDownloader::stopDownloadDeadlineTimer()
}
/*!
- Sets the download into a paused state.
+ Sets the download into a \a paused state.
*/
void KDUpdater::FileDownloader::setDownloadPaused(bool paused)
{
@@ -432,7 +442,7 @@ void KDUpdater::FileDownloader::setDownloadPaused(bool paused)
}
/*!
- Gets the download paused state.
+ Returns the download paused state.
*/
bool KDUpdater::FileDownloader::isDownloadPaused()
{
@@ -440,7 +450,7 @@ bool KDUpdater::FileDownloader::isDownloadPaused()
}
/*!
- Sets the download into a paused state.
+ Sets the download into a \a resumed state.
*/
void KDUpdater::FileDownloader::setDownloadResumed(bool resumed)
{
@@ -448,7 +458,7 @@ void KDUpdater::FileDownloader::setDownloadResumed(bool resumed)
}
/*!
- Gets the download resumed state.
+ Returns the download resumed state.
*/
bool KDUpdater::FileDownloader::isDownloadResumed()
{
@@ -481,7 +491,7 @@ void KDUpdater::FileDownloader::clearBytesDownloadedBeforeResume()
}
/*!
- Updates the amount of bytes downloaded before download resume.
+ Updates the amount of \a bytes downloaded before download resumes.
*/
void KDUpdater::FileDownloader::updateBytesDownloadedBeforeResume(qint64 bytes)
{
diff --git a/src/libs/kdtools/localpackagehub.cpp b/src/libs/kdtools/localpackagehub.cpp
index 14e6b5738..d6208a610 100644
--- a/src/libs/kdtools/localpackagehub.cpp
+++ b/src/libs/kdtools/localpackagehub.cpp
@@ -311,7 +311,8 @@ void LocalPackageHub::refresh()
\a virtualComp,
\a uncompressedSize,
\a inheritVersionFrom,
- and \a checkable for the package.
+ \a checkable,
+ and \a expandedByDefault for the package.
*/
void LocalPackageHub::addPackage(const QString &name,
const QString &version,
diff --git a/tools/archivegen/archive.cpp b/tools/archivegen/archive.cpp
index eac794585..d31e8fdc3 100644
--- a/tools/archivegen/archive.cpp
+++ b/tools/archivegen/archive.cpp
@@ -184,7 +184,7 @@ int main(int argc, char *argv[])
}
Lib7z::initSevenZ();
- Lib7z::createArchive(args[0], args.mid(1), Lib7z::QTmpFile::No, Lib7z::Compression(value),
+ Lib7z::createArchive(args[0], args.mid(1), Lib7z::TmpFile::No, Lib7z::Compression(value),
[&] () -> Lib7z::UpdateCallback * {
if (parser.isSet(verbose))
return new VerbosePrinterCallback;
diff --git a/tools/common/repositorygen.cpp b/tools/common/repositorygen.cpp
index a1144a005..7034d32fb 100644
--- a/tools/common/repositorygen.cpp
+++ b/tools/common/repositorygen.cpp
@@ -682,7 +682,7 @@ void QInstallerTools::compressMetaDirectories(const QString &repoDir, const QStr
const QString absPath = sd.absolutePath();
const QString fn = QLatin1String(versionPrefix.toLatin1() + "meta.7z");
const QString tmpTarget = repoDir + QLatin1String("/") +fn;
- Lib7z::createArchive(tmpTarget, QStringList() << absPath, Lib7z::QTmpFile::No);
+ Lib7z::createArchive(tmpTarget, QStringList() << absPath, Lib7z::TmpFile::No);
// remove the files that got compressed
QInstaller::removeFiles(absPath, true);
@@ -742,7 +742,7 @@ void QInstallerTools::copyComponentData(const QStringList &packageDirs, const QS
qDebug() << "Compressing data directory" << entry;
QString target = QString::fromLatin1("%1/%3%2.7z").arg(namedRepoDir, entry, info.version);
Lib7z::createArchive(target, QStringList() << dataDir.absoluteFilePath(entry),
- Lib7z::QTmpFile::No);
+ Lib7z::TmpFile::No);
compressedFiles.append(target);
} else if (fileInfo.isSymLink()) {
filesToCompress.append(dataDir.absoluteFilePath(entry));
@@ -754,7 +754,7 @@ void QInstallerTools::copyComponentData(const QStringList &packageDirs, const QS
qDebug() << "Compressing files found in data directory:" << filesToCompress;
QString target = QString::fromLatin1("%1/%3%2").arg(namedRepoDir, QLatin1String("content.7z"),
info.version);
- Lib7z::createArchive(target, filesToCompress, Lib7z::QTmpFile::No);
+ Lib7z::createArchive(target, filesToCompress, Lib7z::TmpFile::No);
compressedFiles.append(target);
}