Added decomentation and some explenation to dict download mechanism

[mdictionary] / src / plugins / xdxf / XdxfDictDownloader.h

diff --git a/src/plugins/xdxf/XdxfDictDownloader.h b/src/plugins/xdxf/XdxfDictDownloader.h
index 3f16509..5968371 100644 (file)
--- a/src/plugins/xdxf/XdxfDictDownloader.h
+++ b/src/plugins/xdxf/XdxfDictDownloader.h
@@ -32,16 +32,27 @@
 #include <DownloadDict.h>
 #include "XdxfDictDownloadProgressDialog.h"
 
+/** XdxfDictDownloader is responsible for getting dict list from XDXF website
+    and other actions necessary to download and add dictionary
+
+    When user want to add dictionary he may choose "browse" or "download",
+    after selecting "download"  XDXFDictDownloader would present him list of
+    dictionaries and when he select one downloading would be started. Next
+    step is to extract archive and move file to ~/.mdictionary
+*/
 class XdxfDictDownloader : public QObject {
     Q_OBJECT
 public:
     XdxfDictDownloader(QObject *parent = 0);
+    //! \return name of downloaded file
     QString downloadedFile();
 
 public Q_SLOTS:
+    //! downloads dictionaries list from xdxf website
     void download(QWidget* parent);
 
 Q_SIGNALS:
+    //! emmited when file download precess is complete
     void fileDownloaded(QString);
 
 private Q_SLOTS: