Merge branch 'master' of ssh://drop.maemo.org/git/mdictionary

[mdictionary] / src / mdictionary / gui / MainWindow.h

diff --git a/src/mdictionary/gui/MainWindow.h b/src/mdictionary/gui/MainWindow.h
index 7053195..9e9a988 100644 (file)
--- a/src/mdictionary/gui/MainWindow.h
+++ b/src/mdictionary/gui/MainWindow.h
@@ -48,7 +48,7 @@
   Only this class has direct access to backbone object.
   It manages all requests of subcomponents e. g. searching of given word,
   displaying history, removing dictionary.
-  It also provide data from backbone to subcomponents e. g. result of search.
+  It also provides data from backbone to subcomponents e. g. result of search.
 */
 class MainWindow : public GUIInterface
 {
@@ -79,7 +79,7 @@ public:
 
     //! Indicates if GUI is in exact search mode.
     /*! When GUI is in exact search mode it searches for word, and if it
-        finds exactly matching translation it displaying matching words list
+        finds exactly matching translation it displays matching words list
         and then directly displays translation of first exactly matched word.
         This mode is used for browsing search history and searching words
         from application arguments.
@@ -108,25 +108,25 @@ public:
     //! Searches in exact mode for given word
     /*!
       GUI will be automatically set into exact search mode, and after search or
-      when user break the search it will be unset from exact search mode.
+      when user breaks the search it will be unset from exact search mode.
       \param word which will be searched in dictionaries
       \sa search()
     */
     void searchExact(QString);
 
 
-    //! Search for given word
+    //! Searches for given word
     /*!
-      It sets passed word in line edit of search bar and search for given word.
+      It sets passed word in line edit of search bar and searches for given word.
       \param word which will be searched in dictionaries
       \sa SearchBarWidget
       \sa searchExact()
     */
     void search(QString);
 
-    //! Start searching for given word after 500 ms delay
+    //! Starts searching for given word after 500 ms delay
     /*!
-      After times up it sets passed word in line edit of search bar and search
+      After time's up it sets passed word in line edit of search bar and searches
       for given word.
       \param word which will be searched in dictionaries
       \sa SearchBarWidget
@@ -144,11 +144,11 @@ public:
 
     //! Sets GUI exact search mode.
     /*! When GUI is in exact search mode it searches for word, and if it
-        finds exactly matching translation it displaying matching words list
+        finds exactly matching translation it displays matching words list
         and then directly displays translation of first exactly matched word.
         This mode is used for browsing search history and searching words
         from application arguments.
-        \param exactSearch flag indicating if GUI will be in exact search mode
+        \param exactSearch flag indicating if GUI is in exact search mode
         \sa isInExactSearch()
         \sa setExactSearchString()
     */
@@ -157,11 +157,11 @@ public:
 
     //! Gets word list from backbone and prepares received list to display
     /*!
-      Checks if received list is empty, in that case displays suitable
-      information. Otherwise it merge results of the same key word and emit
+      Checks if received list is empty, in that case it displays suitable
+      information. Otherwise it merges results of the same key word and emits
       signal to display word list.
       If GUI is in exact search mode it will search for exact word in received
-      list and if any of found words match exacly the word passed to
+      list and if any of found words match exactly the word passed to
       searchExact() method.
       \sa isInExactSearch()
       \sa searchExact()
@@ -173,7 +173,7 @@ public:
     //! Gets translation strings from backbone and emits signal to display them
     void translationsReady();
 
-    //! Adds to history key words from given translations
+    //! Adds key words from given translations to history
     /*!
       By default this slot is connected to searchTranslations signal, and
       passed translation list contains only translations with the same key, so
@@ -185,16 +185,16 @@ public:
 
     //! Shows history dialog
     /*!
-       In meamo shows dialog with history.
-       In desktop shows popup containing history, which bottom edge is on the
+       In maemo it shows dialog with history.
+       In desktop it shows popup containing history, whose bottom edge is on the
        same height as passed point.
-       \param point on screen when popup has to show
+       \param point on screen where popup has to show
     */
     void showHistory(QPoint);
 
     //! 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 searchDelay() function.
       On maemo search is in normal mode, on desktop in exact search mode.
       \sa searchDelay()
@@ -213,12 +213,12 @@ public:
     void historyPrev();
 
 
-    //! Shows notify to user
+    //! Shows notification to user
     /*!
-      It shows different type of notyfies as informations, warnings and errors.
+      It shows different types of notifications such as information, warnings and errors.
       In maemo they are represented as notes, on desktop as message boxes.
-      \param type type of notify
-      \param message notify message
+      \param type type of notification
+      \param message notification message
     */
     void showNotification(Notify::NotifyType type, QString message);
 
@@ -233,7 +233,7 @@ private Q_SLOTS:
     //! disabled
     void searchingInterrupted();
 
-    //! Asks for confirmation when user click on "delete all bookmarks"
+    //! Asks for confirmation when user clicks on "delete all bookmarks"
     void removeBookmarks();
 
 protected: