Added comments to XdxfLoadDialog

[mdictionary] / trunk / src / plugins / xdxf / src / XdxfPlugin / XdxfLoadDialog.h

diff --git a/trunk/src/plugins/xdxf/src/XdxfPlugin/XdxfLoadDialog.h b/trunk/src/plugins/xdxf/src/XdxfPlugin/XdxfLoadDialog.h
index 88c3711..fd367e5 100644 (file)
--- a/trunk/src/plugins/xdxf/src/XdxfPlugin/XdxfLoadDialog.h
+++ b/trunk/src/plugins/xdxf/src/XdxfPlugin/XdxfLoadDialog.h
@@ -28,13 +28,22 @@
 #include <QtGui>
 #include "../../../../includes/settings.h"
 
-
+//! Displays dialog which allow user to add new xdxf dictionary
 class XdxfLoadDialog : public QDialog {
     Q_OBJECT
 public:
     explicit XdxfLoadDialog(QWidget *parent = 0);
+
+    /*! Displays dialog and returns settings of new dictionary
+        \return Setting object containing new dictionary settings or NULL in
+        case which user cancel dialog
+    */
     static Settings* getSettings(QWidget *parent);
+
+    //! Returns choosen by user dictionary file path
     QString dicitonaryFilePath();
+
+    //! Returns if user want to cache dictionary
     bool generateCache();
 
 signals: