further code cleanup
[mdictionary] / trunk / src / includes / GUIInterface.h
index 17aa8ee..8eb4934 100644 (file)
@@ -62,10 +62,10 @@ public:
     virtual QList<CommonDictInterface*> getPlugins() = 0;
 
     //! Indicates if GUI is in exact search mode.
-    /*! When GUI is in exact search mode it search for word, and
-        if find exacly matching translation it directly displays it, whithout
+    /*! When GUI is in exact search mode it searches for word, and
+        if it finds exactly matching translation it directly displays it, without
         displaying matching word list. This mode should be
-        used for browsing search history and search words from application
+        used for browsing search history and searching words from application
         arguments.
         \returns flag indicating if GUI is in exact search mode
     */
@@ -81,9 +81,9 @@ public:
 
 
 public Q_SLOTS:
-    //! Search in exact mode for given word
+    //! Searches in exact mode for given word
     /*!
-      GUI will be automaticaly set into exact search mode, and after search or
+      GUI will be automatically set into exact search mode, and after search or
       break will be unset from exact search mode.
       \param word which will be searched in dictionaries
       */
@@ -123,68 +123,68 @@ public Q_SLOTS:
       Checks if received list is empty, in that case 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 it's translation. Otherwise it will display list of matching
+      display its translation. Otherwise it will display list of matching
       words and show suitable information.
       \sa exactSearch()
       \sa showTranslation()
      */
     virtual void wordListReady() = 0;
 
-    //! Gets translation strings from backbone and emit signal to display them
+    //! Gets translation strings from backbone and emits signal to display them
     virtual void translationsReady() = 0;
 
 Q_SIGNALS:
-    //! Should be emited when user wants to close application to stop
+    //! Should be emitted when user wants to close application to stop
     //! all ongoing searches
     void quit();
 
-    //! Emited when user want to search for list of words matching given word
-    /*! \param word word which will be matched, it can contains wildcards
+    //! Emitted when user wants to search for list of words matching given word
+    /*! \param word word which will be matched, it can contain wildcards
     */
     void searchWordList(QString word);
 
-    //! Emited when user wants to see translation of words.
+    //! Emitted when user wants to see translation of words.
     /*! \param list of translations for given word which will be received
         in wordListReady() slot
         \sa wordListReady()
     */
     void searchTranslations(QList<Translation*>);
 
-    //! Emited when starting search, will disable GUI components
+    //! Emitted when starting search, will disable GUI components
     //! and shows progress bars
     void setBusy();
 
-    //! Emited when searching ends, will enable GUI components
+    //! Emitted when searching ends, will enable GUI components
     void setIdle();
 
-    //! Emited when user want to break search
+    //! Emitted when user wants to break search
     void stopSearching();
 
-    //! Emited after received word list in wordListReady() slot, will display
+    //! 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
          in dictionaries
      */
     void showWordList(QHash<QString, QList<Translation*> >);
 
-    //! Emited after received translation strings in translationsReady() slot,
+    //! Emitted after receiving translation strings in translationsReady() slot,
     //! will display translation of given word
     /*! \param list of translations from different dictionaries
          in dictionaries
      */
     void showTranslation(QStringList);
 
-    //! Emited when user wants to add new dictionary
-    /*! \param new dictionary returned by specyfic plugin dialog
+    //! Emitted when user wants to add new dictionary
+    /*! \param new dictionary returned by specific plugin dialog
       */
     void addNewDictionary(CommonDictInterface*);
 
-    //! Emited when user wants to remove dictionary
+    //! Emitted when user wants to remove dictionary
     /*! \param dictionary which will be removed
       */
     void removeDictionary(CommonDictInterface*);
 
-    //! Emited when user changes dictionaries active/inactive states
+    //! Emitted when user changes dictionaries active/inactive states
     /*! \param list of only active dictionaries
       */
     void selectedDictionaries(QList<CommonDictInterface* >);