Add comments and translations for xdxf downloading dialog

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

diff --git a/src/plugins/xdxf/XdxfDictSelectDialog.h b/src/plugins/xdxf/XdxfDictSelectDialog.h
index 5f6dfcc..996cee8 100644 (file)
--- a/src/plugins/xdxf/XdxfDictSelectDialog.h
+++ b/src/plugins/xdxf/XdxfDictSelectDialog.h
@@ -19,7 +19,10 @@
 
 *******************************************************************************/
 
-//Created by Mateusz Półrola
+/*!
+  \file XdxfDictSelectDialog.h
+  \author Mateusz Półrola <mateusz.polrola@comarch.com>
+  */
 
 #ifndef XDXFDICTSELECTDIALOG_H
 #define XDXFDICTSELECTDIALOG_H
@@ -30,16 +33,31 @@
 #include "DictsModel.h"
 #include "DictsProxyModel.h"
 
+
+/*!
+  Shows dialog with list of dictionaries and informations about them, allowing user to filter data based on dictionaries languages, and to select one of them.
+  */
 class XdxfDictSelectDialog : public QDialog {
     Q_OBJECT
 public:
-    explicit XdxfDictSelectDialog(QList<DownloadDict> dicts,
+    /*!
+      Constructor
+      \param dicts list of DownloadDict objects describing dictionaries.
+      */
+    XdxfDictSelectDialog(QList<DownloadDict> dicts,
                                   QWidget *parent = 0);
+
+    /*!
+      Returns download link of dictionary selected by user. This string is set
+      only when user select any dictionary (dialog was accepted), otherwise it
+     is empty.
+      */
     QString link() { return _link;}
 
 private:
     QTreeView* treeView;
     DictsModel* model;
+    //used by treeView to allow filtering and sorting
     DictsProxyModel *proxyModel;
     QVBoxLayout* layout;
     QHBoxLayout* checkBoxLayout;
@@ -49,8 +67,13 @@ private:
     QLabel* langToLabel;
 
 private Q_SLOTS:
+    //creates items for comboboxes and creates model with dicts info
     void initializeDicts();
+
+    //filters dicts after filtering settings change
     void refreshDictList();
+
+    //accept dialog and sets download link of clicked dictionary
     void itemClicked(QModelIndex);
 
 private: