diff options
author | Katja Marttila <katja.marttila@qt.io> | 2021-01-28 17:36:37 +0200 |
---|---|---|
committer | Katja Marttila <katja.marttila@qt.io> | 2021-02-04 12:38:26 +0200 |
commit | 8dcc1bb8ceabcd30dd3c73c2f9fa23393f6602a8 (patch) | |
tree | 03030b0d0aa115f68fd26c2d58945d81371ecfbb /src | |
parent | cf48632f89383c9f96346ef8d0ac794f611766a0 (diff) |
Provide missing documentation for functions
Change-Id: I2fe4f6bfc6a31291900d0005550c419cf6582fac
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/libs/installer/lib7z_facade.cpp | 6 | ||||
-rw-r--r-- | src/libs/installer/repository.cpp | 6 | ||||
-rw-r--r-- | src/libs/installer/repositorycategory.cpp | 6 | ||||
-rw-r--r-- | src/libs/kdtools/update.cpp | 5 | ||||
-rw-r--r-- | src/libs/kdtools/updatefinder.cpp | 15 |
5 files changed, 38 insertions, 0 deletions
diff --git a/src/libs/installer/lib7z_facade.cpp b/src/libs/installer/lib7z_facade.cpp index 591973c34..fc6ac7ae4 100644 --- a/src/libs/installer/lib7z_facade.cpp +++ b/src/libs/installer/lib7z_facade.cpp @@ -197,6 +197,9 @@ namespace Lib7z { std::once_flag gOnceFlag; +/*! + Initializes 7z and registers codecs and compression methods. +*/ void initSevenZ() { std::call_once(gOnceFlag, [] { @@ -563,6 +566,9 @@ bool operator==(const File &lhs, const File &rhs) || rhs.permissions == static_cast<QFile::Permissions>(-1)); } +/*! + Returns a list of files belonging to an \a archive. +*/ QVector<File> listArchive(QFileDevice *archive) { LIB7Z_ASSERTS(archive, Readable) diff --git a/src/libs/installer/repository.cpp b/src/libs/installer/repository.cpp index 7e7f95354..e959d8550 100644 --- a/src/libs/installer/repository.cpp +++ b/src/libs/installer/repository.cpp @@ -33,6 +33,12 @@ #include <QFileInfo> #include <QStringList> +/*! + \fn inline uint QInstaller::qHash(const Repository &repository) + + Returns a hash of the \a repository. +*/ + namespace QInstaller { /* diff --git a/src/libs/installer/repositorycategory.cpp b/src/libs/installer/repositorycategory.cpp index 89f88c1d7..0b875b27a 100644 --- a/src/libs/installer/repositorycategory.cpp +++ b/src/libs/installer/repositorycategory.cpp @@ -34,6 +34,12 @@ #include <QFileInfo> #include <QStringList> +/*! + \fn inline uint QInstaller::qHash(const RepositoryCategory &repository) + + Returns a hash of the repository category \a repository. +*/ + namespace QInstaller { diff --git a/src/libs/kdtools/update.cpp b/src/libs/kdtools/update.cpp index 5a77788ed..99869035d 100644 --- a/src/libs/kdtools/update.cpp +++ b/src/libs/kdtools/update.cpp @@ -42,6 +42,11 @@ using namespace KDUpdater; KDUpdater::UpdateFinder (which is a friend class). The destructor however is public. */ +/*! + \fn KDUpdater::Update::packageSource() const + + Returns the package source. +*/ /*! \internal diff --git a/src/libs/kdtools/updatefinder.cpp b/src/libs/kdtools/updatefinder.cpp index c64d9b487..535dfde3d 100644 --- a/src/libs/kdtools/updatefinder.cpp +++ b/src/libs/kdtools/updatefinder.cpp @@ -55,6 +55,18 @@ using namespace QInstaller; objects. */ +/*! + \fn void KDUpdater::UpdateFinder::addCompressedPackage(bool add) + \internal + +*/ + +/*! + \fn void KDUpdater::UpdateFinder::isCompressedPackage() + \internal + +*/ + // // Private // @@ -476,6 +488,9 @@ QList<Update *> UpdateFinder::updates() const return d->updates.values(); } +/*! + Sets the information about installed local packages \a hub. +*/ void UpdateFinder::setLocalPackageHub(std::weak_ptr<LocalPackageHub> hub) { d->m_localPackageHub = std::move(hub); |