DOC: Some documentation fixes

Change-Id: I6a1fa5072a44995d781cb83f9474293d928083bb Reviewed-by: Arttu Tarkiainen <[email protected]>
42sol-eu · May 17, 2024 · fce04dd · fce04dd
1 parent 0633bf6
commit fce04dd
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 2 deletions.
diff --git a/examples/doc/componentalias.qdoc b/examples/doc/componentalias.qdoc
@@ -33,6 +33,8 @@
     \brief Using installer's aliases.xml file to define component aliases and their
            relations to other aliases and components.
 
+    \image qtifw-examples-componentalias.png
+
     \e{Component Alias} illustrates how to specify component aliases and how they influence
     the installation and maintenance processes for command line usage.
 

diff --git a/examples/doc/images/qtifw-examples-componentalias.png b/examples/doc/images/qtifw-examples-componentalias.png
diff --git a/src/libs/installer/binaryformat.cpp b/src/libs/installer/binaryformat.cpp
@@ -151,7 +151,7 @@ void Resource::setName(const QByteArray &name)
 
 /*!
     Opens a resource in QIODevice::ReadOnly mode. The function returns \c true
-    if successful.
+    if successful. Optionally, \a permissions can be given.
 */
 #if QT_VERSION < QT_VERSION_CHECK(6, 3, 0)
 bool Resource::open()

diff --git a/src/libs/installer/packagemanagercore.cpp b/src/libs/installer/packagemanagercore.cpp
@@ -146,6 +146,8 @@ using namespace QInstaller;
             Installation has to be updated.
     \value  EssentialUpdated
             Installation essential components were updated.
+    \value  NoPackagesFound
+            No packages found from remote.
 */
 
 /*!

diff --git a/src/libs/kdtools/filedownloader.cpp b/src/libs/kdtools/filedownloader.cpp
@@ -650,7 +650,7 @@ void KDUpdater::FileDownloader::emitEstimatedDownloadTime()
 }
 
 /*!
-    \overload addCheckSumData()
+    Adds checksum \a data.
 */
 void KDUpdater::FileDownloader::addCheckSumData(const QByteArray &data)
 {
-Original file line number
+Diff line change
@@ Expand Up / @@ -650,7 +650,7 @@ void KDUpdater::FileDownloader::emitEstimatedDownloadTime() @@
     }
     /*!
-        \overload addCheckSumData()
+        Adds checksum \a data.
     */
     void KDUpdater::FileDownloader::addCheckSumData(const QByteArray &data)
     {
@@ Expand Down @@