fix small bug(wildcard), and change some comments

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

diff --git a/src/mdictionary/backbone/Bookmarks.h b/src/mdictionary/backbone/Bookmarks.h
index 370f42f..986f225 100644 (file)
--- a/src/mdictionary/backbone/Bookmarks.h
+++ b/src/mdictionary/backbone/Bookmarks.h
@@ -19,12 +19,12 @@
 
 *******************************************************************************/
 
-/*! \file Bookmarks.h
-\brief Bookmarks functionality - marking words as favorite, managing marked
+/*!
+    \file Bookmarks.h
+    \brief Bookmarks functionality - marking words as favorite, managing marked
     words, searching in marked words (with cached translations)
 
-
-\author Bartosz Szatkowski <bulislaw@linux.com>
+    \author Bartosz Szatkowski <bulislaw@linux.com>
 */
 
 #ifndef BOOKMARKS_H
@@ -46,54 +46,63 @@
 class BookmarkTranslation;
 
 
-/*! Bookmarks are a way to store words that You think You will need to search
-  for often.
+/*!
+    Bookmarks are a way to store words that You think You will need to search
+    for often.
 
-  When You add a bookmark (by clicking on "star" in words list) You add it to
-  a special list with cached translations from all available dictionaries so
-  You can search for them quickly even when You delete corresponding dict.
-  */
+    When You add a bookmark (by clicking on "star" in words list) You add it to
+    a special list with cached translations from all available dictionaries so
+    You can search for them quickly even when You delete corresponding dict.
+*/
 class Bookmarks : public AccentsNormalizer {
 public:
     Bookmarks();
     ~Bookmarks();
 
-    /*! Adds new word and translation to bookmarks
-      \param translation new translation to be saved and cached as a bookmark
+    /*!
+        Adds new word and translation to bookmarks
+        \param translation new translation to be saved and cached as a bookmark
     */
     void add(Translation* translation);
 
-    /*! Removes word and corresponding translation cache from bookmarks list
+    void add(QString key,QString removeAccentKey,QString value);
+
+    /*!
+        Removes word and corresponding translation cache from bookmarks list
         \param translation translation to be removed
     */
     void remove(Translation* translation);
 
-    /*! \return all bookmarks (word and translation as a translation object
-     as a list)
-     */
+    /*!
+        \return all bookmarks (word and translation as a translation object
+        as a list)
+    */
     QList<Translation*> list();
 
-    /*! Searches in bookmarks for a given word (wildcards may apply '*' and '?')
-      \param word word to search for
-      \return list of matching Translation objects
-      */
+    /*!
+        Searches in bookmarks for a given word (wildcards may apply '*' and '?')
+        \param word word to search for
+        \return list of matching Translation objects
+    */
     QList<Translation*> searchWordList(QString word);
 
-    /*! Searches for final translation of a given word
-      \return word translation list in text format xml or html to be formatted
+    /*!
+        Searches for final translation of a given word
+        \return word translation list in text format xml to be formatted
         and displayed
-      \param word word to search for
-      */
+        \param word word to search for
+    */
     QStringList search(QString word, QString dbname);
 
-
-    /*! Clears bookmarks database */
+    /*!
+        Clears bookmarks database
+    */
     void clear();
 
-
-    /*! \return true if a given word is already in bookmarks
-      \param word word to check
-      */
+    /*!
+        \return true if a given word is already in bookmarks
+        \param word word to check
+    */
     bool inBookmarks(QString word);
 
 private: