Added comments to XdxfLoadDialog

diff --git a/trunk/src/includes/DictDialog.h b/trunk/src/includes/DictDialog.h
index 0e32ee1..7932404 100644 (file)
--- a/trunk/src/includes/DictDialog.h
+++ b/trunk/src/includes/DictDialog.h
@@ -28,12 +28,23 @@
 
 class Settings;
 
+//! Interface for plugin dialog provider
 class DictDialog : public QObject {
     Q_OBJECT
 
 public:
     DictDialog(QObject*parent=0) : QObject(parent) {}
+
+    /*!
+      Shows add new dictionary dialog and returns settings of new dict
+      \param parent parent widget on which will be displayed dialog
+      */
     virtual Settings* addNewDictionary(QWidget*parent=0)=0;
+
+    /*!
+      Shows settings dialog and save new settings in plugin
+      \param parent parent widget on which will be displayed dialog
+      */
     virtual void changeSettings(QWidget*parent=0)=0;
 };
 

diff --git a/trunk/src/plugins/xdxf/src/XdxfPlugin/XdxfDictDialog.h b/trunk/src/plugins/xdxf/src/XdxfPlugin/XdxfDictDialog.h
index 1dd98c2..b9292f6 100644 (file)
--- a/trunk/src/plugins/xdxf/src/XdxfPlugin/XdxfDictDialog.h
+++ b/trunk/src/plugins/xdxf/src/XdxfPlugin/XdxfDictDialog.h
@@ -28,12 +28,22 @@
 #include "XdxfLoadDialog.h"
 
 
+//! Implementation of DictDialog interface for xdxf plugin
 class XdxfDictDialog : public DictDialog {
     Q_OBJECT
 public:
     explicit XdxfDictDialog(QObject *parent = 0);
 
+    /*!
+      Shows add new xdxf dictionary dialog and returns settings of new dict
+      \param parent parent widget on which will be displayed dialog
+      */
     Settings* addNewDictionary(QWidget *parent);
+
+    /*!
+      Shows settings dialog and save new settings in plugin
+      \param parent parent widget on which will be displayed dialog
+      */
     void changeSettings(QWidget *parent);
 };
 

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: