Further improvements in documentation

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

diff --git a/src/mdictionary/backbone/Bookmarks.h b/src/mdictionary/backbone/Bookmarks.h
index 472ac2b..fb4ffd2 100644 (file)
--- a/src/mdictionary/backbone/Bookmarks.h
+++ b/src/mdictionary/backbone/Bookmarks.h
@@ -46,7 +46,7 @@
 class BookmarkTranslation;
 
 
-/*! Bookmarks are way to store words that You think You will need to search
+/*! Bookmarks are a way to store words that You think You will need to search
   for often.
 
   When You add bookmark (by clicking on "star" in words list) You add it to
@@ -73,13 +73,13 @@ public:
      */
     QList<Translation*> list();
 
-    /*! Searches in bookmarks for given word (wildcards may apply '*' and '?')
+    /*! Searches in bookmarks for a given word (wildcards may apply '*' and '?')
       \param word to search for
       \return list of matching Translation objects
       */
     QList<Translation*> searchWordList(QString word);
 
-    /*! Searches for final translation of given word
+    /*! Searches for final translation of a given word
       \return word translation list in text format xml or html to be formatted
         and displayed
       \param word word to search for
@@ -91,7 +91,7 @@ public:
     void clear();
 
 
-    /*! \return true if given word is already in bookmarks
+    /*! \return true if a given word is already in bookmarks
       \param word to check
       */
     bool inBookmarks(QString word);