Clean and order documentation in source files. Source ready to beta 2 release

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

diff --git a/src/mdictionary/gui/MainWindow.h b/src/mdictionary/gui/MainWindow.h
index b4738b3..c42482d 100644 (file)
--- a/src/mdictionary/gui/MainWindow.h
+++ b/src/mdictionary/gui/MainWindow.h
@@ -18,8 +18,11 @@
     Copyright 2010 Comarch S.A.
 
 *******************************************************************************/
-//! \file MainWindow.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file MainWindow.h
+    \brief Implements interface for GUI
+
+    \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
 
 #ifndef MAINWINDOW_H
 #define MAINWINDOW_H
@@ -41,13 +44,12 @@
 #include "NotifyManager.h"
 
 
-//! Implements interface for GUI
 /*!
   Creates all of GUI subcomponents, and connects all GUI interface signals
   with suitable backbone signals and slots.
   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 manages all requests of subcomponents e. g. searching for a given word,
+  displaying history, removing a dictionary.
   It also provides data from backbone to subcomponents e. g. result of search.
 */
 class MainWindow : public GUIInterface
@@ -57,17 +59,17 @@ class MainWindow : public GUIInterface
 public:
     //! Constructor
     /*!
-      \param backbone object which will be doing all searches and returning data
+      \param backbone backbone object which will be doing all searches and returning data
       \param parent parent widget of this window
     */
     MainWindow(Backbone* backbone, QWidget *parent = 0);
     ~MainWindow();
 
-    //! Returns all loaded dictionaries with infromation about that they are
+    //! Returns all loaded dictionaries with information if they are
     //! active/inactive
     /*!
-        \return Hash of pointers to dictionary and boolean flag indicating if
-        dictionary is active
+        \return Hash of pointers to a dictionary and boolean flag indicating if
+        a dictionary is active
     */
     QHash<CommonDictInterface*, bool> getDictionaries();
 
@@ -78,7 +80,7 @@ public:
     QList<CommonDictInterface*> getPlugins();
 
     //! Indicates if GUI is in exact search mode.
-    /*! When GUI is in exact search mode it searches for word, and if it
+    /*! When GUI is in exact search mode it searches for a word, and if it
         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
@@ -105,30 +107,30 @@ public:
 
 
  public Q_SLOTS:
-    //! Searches in exact mode for given word
+    //! Searches in exact mode for a given word
     /*!
       GUI will be automatically set into exact search mode, and after search or
       when user breaks the search it will be unset from exact search mode.
-      \param word which will be searched in dictionaries
+      \param word which will be searched for in dictionaries
       \sa search()
     */
     void searchExact(QString);
 
 
-    //! Searches for given word
+    //! Searches for a 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
+      It sets passed word in line edit of a search bar and searches for a given word.
+      \param word which will be searched for in dictionaries
       \sa SearchBarWidget
       \sa searchExact()
     */
     void search(QString);
 
-    //! Starts searching for given word after 500 ms delay
+    //! Starts searching for a given word after 500 ms delay
     /*!
       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
+      for a given word.
+      \param word which will be searched for in dictionaries
       \sa SearchBarWidget
       \sa searchExact()
       \sa search()
@@ -152,7 +154,7 @@ public:
         \sa isInExactSearch()
         \sa setExactSearchString()
     */
-    void setExactSearch(bool);
+    void setExactSearch(bool exactSearch);
 
 
     //! Gets word list from backbone and prepares received list to display
@@ -160,7 +162,7 @@ public:
       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
+      If GUI is in exact search mode it will search for an exact word in received
       list and if any of found words match exactly the word passed to
       searchExact() method.
       \sa isInExactSearch()
@@ -195,7 +197,7 @@ public:
     //! Shows translation of next word in history
     /*!
       It will work only if there is next word available in history.
-      Translation of word is searched with searchDelay() function.
+      Translation of a word is searched for with searchDelay() function.
       On maemo search is in normal mode, on desktop in exact search mode.
       \sa searchDelay()
       \sa searchExact()
@@ -204,8 +206,8 @@ public:
 
     //! Shows translation of previous word in history
     /*!
-      It will work only if there is available previous word in history.
-      Translation of word is searched with searchDelay() function.
+      It will work only if there is previous word available in history.
+      Translation of a word is searched for with searchDelay() function.
       On maemo search is in normal mode, on desktop in exact search mode.
       \sa searchDelay()
       \sa searchExact()