Merge branch 'master' into google

[mdictionary] / src / mdictionary / backbone / backbone.h

diff --git a/src/mdictionary/backbone/backbone.h b/src/mdictionary/backbone/backbone.h
index a9f05c0..be84df7 100644 (file)
--- a/src/mdictionary/backbone/backbone.h
+++ b/src/mdictionary/backbone/backbone.h
@@ -80,7 +80,7 @@
      * search_bookmarks - true/false, whether search in bookmarks
 
     Searching schema:
-        At first GUI should ask for list of words matching given pattern,
+        At first GUI should ask for a list of words matching a given pattern,
         then each Translation object is capable of finding its own final translation
 
       List of words:
@@ -105,9 +105,9 @@ class Backbone : public QObject
     Q_OBJECT
 
 public:
-    /*!\param pluginPath path to plugins (leave blank for default)
-      \param configPath path to folder with configuration files
-      \param dry dry run is mode without paying attention to configuration etc
+    /*! \param pluginPath path to plugins (leave blank for default)
+        \param configPath path to folder with configuration files
+        \param dry dry run is mode without paying attention to configuration etc
           mainly for testing
       */
     Backbone(QString pluginPath="", QString configPath="",
@@ -124,7 +124,7 @@ public:
     //! \return history of performed searches
     History* history();
 
-    //! \return return search fesult
+    //! \return search fesult
     QMultiHash<QString, Translation*> result();
 
     //! \return maximum number of words that plugin could find
@@ -145,16 +145,16 @@ public Q_SLOTS:
     void stopSearching();
 
     /*! searches for a word translation
-       \param word to be translated
+       \param word word to be translated
       */
     void search(QString word);
 
     /*! sets active dictionaries (searches are performed only in active dicts)
        \param List of dictionaries to be activated
       */
-    void selectedDictionaries(QList<CommonDictInterface* >);
+    void selectedDictionaries(QList<CommonDictInterface*>);
 
-    /*! adds new dictionary and activates it
+    /*! adds a new dictionary and activates it
       \param dict dictionary to be added
       \param active decides whether searches are perfomed in given dictionaries
       */
@@ -165,7 +165,7 @@ public Q_SLOTS:
     void quit();
 
 
-    /*! Fired by FutureWatcher when list of words is ready (after calling search)
+    /*! Fired by FutureWatcher when a list of words is ready (after calling search),
         fetch Future<...> to final result
       */
     void translationReady();
@@ -175,7 +175,7 @@ public Q_SLOTS:
       */
     void xmlTranslationReady();
 
-    /*! Removes given dictionary
+    /*! Removes a given dictionary
         \param dict dictionary to be deleted
       */
     void removeDictionary(CommonDictInterface* dict);
@@ -191,7 +191,7 @@ public Q_SLOTS:
 
     /*! adds bookmarks to given translations (translation object is fetched and
       added to bookmarks data base (key and translation stored in db))
-      \param translation translation object to be stored in db
+      \param translations list of Translation objects to be stored in db
       */
     void addBookmark(QList<Translation*> translations) {
         foreach(Translation* translation, translations)
@@ -201,7 +201,7 @@ public Q_SLOTS:
 
 
     /*! Removes bookmarks to given translations
-      \param translation remove bookmark to this translation
+      \param translations remove bookmark to these translations
       */
     void removeBookmark(QList<Translation*> translations) {
         foreach(Translation* translation, translations)
@@ -217,7 +217,7 @@ public Q_SLOTS:
     }
 
 
-   /*! Searching a list of bookmarks may take some time, so I moved it to
+   /*! Searching a list of bookmarks may take some time, so it's moved to a
        new thread (to avoid GUI blocking), further it's consistent with ordinary
        searching a list of words (\see search)
        */
@@ -272,7 +272,7 @@ Q_SIGNALS:
     /*! emitted by direct connection to plugins notifying signals
         \param Notify::NotifyType GUI may decide to show different types in
             different ways
-        \param QString text of the notification
+        \param text of the notification
     */
     void notify(Notify::NotifyType, QString);