diff ui/downloader.h @ 1255:2a1aa9df8f11

(issue133) Improve API documentation
author Andre Heinecke <andre.heinecke@intevation.de>
date Thu, 25 Sep 2014 17:58:12 +0200
parents 78798d3af8f0
children
line wrap: on
line diff
--- a/ui/downloader.h	Thu Sep 25 17:37:03 2014 +0200
+++ b/ui/downloader.h	Thu Sep 25 17:58:12 2014 +0200
@@ -20,6 +20,14 @@
 
 #include "sslconnection.h"
 
+/** @brief High level API to download necessary data.
+ *
+ * The downloader class is the UI interface to the Update server.
+ * It controls the SSL Connection and checks if updates are available
+ * and downloads them on demand. Each Downloader object is intended
+ * to be run only once and controlled mainly by the constructor of
+ * the object.
+ */
 class Downloader: public QThread
 {
     Q_OBJECT

http://wald.intevation.org/projects/trustbridge/