Merge branch 'master' of ssh://drop.maemo.org/git/mdictionary
[mdictionary] / src / common / GUIInterface.h
index ad92b37..2f10cc1 100644 (file)
@@ -46,7 +46,7 @@ public:
 
     virtual ~GUIInterface() {}
 
-    //! Returns all loaded dictionaries with infromation about that they are
+    //! Returns all loaded dictionaries with information about that they are
     //! active/inactive
     /*!
         \return Hash of pointers to dictionary and boolean flag indicating if
@@ -84,15 +84,15 @@ public Q_SLOTS:
     //! Searches in exact mode for given word
     /*!
       GUI will be automatically set into exact search mode, and after search or
-      break will be unset from exact search mode.
+      break it will be unset from exact search mode.
       \param word which will be searched in dictionaries
       */
     virtual void searchExact(QString word) = 0;
 
-    //! Adds to history key words from given translations
+    //! Adds key words from given translations to history
     /*!
-      By default this slot is connected to signal searchTranslations, and
-      passed translation list contains only translation with the same key, so
+      By default this slot is connected to searchTranslations signal, and
+      passed translations list contains only translations with the same key, so
       only one word is added to history.
       \param list of translations with key words
       \sa searchTranslations();
@@ -104,7 +104,7 @@ public Q_SLOTS:
 
     //! Shows translation of next word in history
     /*!
-      It will work only if there is available next word in history.
+      It will work only if there is next word available in history.
       Translation of word is searched with searchExact() function
       \sa searchExact()
       */
@@ -112,15 +112,15 @@ public Q_SLOTS:
 
     //! Shows translation of previous word in history
     /*!
-      It will work only if there is available previous word in history.
+      It will work only if there is previous word available in history.
       Translation of word is searched with searchExact() function
       \sa searchExact()
       */
     virtual void historyPrev() = 0;
 
-    //! Gets word list from backbone and prepares received list to display
+    //! Gets words list from backbone and prepares received list to display
     /*!
-      Checks if received list is empty, in that case displays suitable
+      Checks if received list is empty, in that case it displays suitable
       information. If GUI is in exact search mode it will search for exact
       word in received list, and if word is found it will emit signal to
       display its translation. Otherwise it will display list of matching
@@ -151,7 +151,7 @@ Q_SIGNALS:
     void searchTranslations(QList<Translation*>);
 
     //! Emitted when starting search, will disable GUI components
-    //! and shows progress bars
+    //! and show progress bars
     void setBusy();
 
     //! Emitted when searching ends, will enable GUI components
@@ -162,7 +162,7 @@ Q_SIGNALS:
 
     //! Emitted after receiving word list in wordListReady() slot, will display
     //! list of matched words
-    /*! \param hash of word and list of translation of this word found
+    /*! \param hash of word and list of translations of this word found
          in dictionaries
      */
     void showWordList(QHash<QString, QList<Translation*> >);