From kde-commits  Sun Jan 30 14:44:24 2011
From: Jonathan Thomas <echidnaman () kubuntu ! org>
Date: Sun, 30 Jan 2011 14:44:24 +0000
To: kde-commits
Subject: =?utf-8?q?=5Blibqapt=5D_src=3A_apidox++?=
Message-Id: <20110130144424.E2289A6094 () git ! kde ! org>
X-MARC-Message: https://marc.info/?l=kde-commits&m=129639869909165

Git commit 011d4cdd14fa87e81e7d6397c13421202c168551 by Jonathan Thomas.
Pushed by jmthomas into branch 'master'.

apidox++

M  +14   -0    src/backend.h     

http://commits.kde.org/d5234754/011d4cdd14fa87e81e7d6397c13421202c168551

diff --git a/src/backend.h b/src/backend.h
index 3180271..984af4d 100644
--- a/src/backend.h
+++ b/src/backend.h
@@ -662,6 +662,20 @@ public Q_SLOTS:
     */
     void updateXapianIndex();
 
+   /**
+    * Add the given .deb package archive to the APT package cache. The .deb
+    * file's corresponding package must already be known to APT. The candidate
+    * version of the package must also match the version that the .deb
+    * provides, and the MD5 sum of the package and the .deb archive must match.
+    *
+    * The main use for this function is to add .deb archives from e.g. a USB
+    * stick so that computers without internet connections can install/upgrade
+    * packages.
+    *
+    * @param archive The .deb archive to be added to the package cache
+    *
+    * @return @c true on success, @c false on failure
+    */
     bool addArchiveToCache(const DebFile &archive);
 
 private Q_SLOTS: