Further improvements in documentation
[mdictionary] / src / include / CommonDictInterface.h
index a3c9790..4e8cebc 100644 (file)
@@ -101,8 +101,8 @@ class CommonDictInterface : public QObject, public AccentsNormalizer {
 
 
  public Q_SLOTS:
-    /*! performs search in dictionary
-        \param  word word to search in dictionary
+    /*! performs search in a dictionary
+        \param  word word to search for in a dictionary
         \param  limit limit on number of results,
                 if limit=0 all matching words are returned
 
@@ -118,7 +118,7 @@ class CommonDictInterface : public QObject, public AccentsNormalizer {
     virtual void retranslate() {}
 
   Q_SIGNALS:
-    //! emitted after change in dictionary settings
+    //! emitted after change in a dictionary settings
     void settingsChanged();
 
     /*! emitted to backbone when it's needed to inform user about something
@@ -130,7 +130,7 @@ class CommonDictInterface : public QObject, public AccentsNormalizer {
     
 
 protected:
-//! removes accents from letters in searched word (e.g. ą -> a, ł -> l)
+//! removes accents from letters in a word searched for (e.g. ą -> a, ł -> l)
     QString removeAccents(QString string) {
         if(settings()->value("strip_accents") == "true")
             return AccentsNormalizer::removeAccents(string);