Merge branch 'stardict' of ssh://drop.maemo.org/git/mdictionary into stardict

[mdictionary] / src / plugins / stardict / StarDictPlugin.h

diff --git a/src/plugins/stardict/StarDictPlugin.h b/src/plugins/stardict/StarDictPlugin.h
index 460874e..48bba05 100644 (file)
--- a/src/plugins/stardict/StarDictPlugin.h
+++ b/src/plugins/stardict/StarDictPlugin.h
@@ -62,7 +62,7 @@ public:
     //! \returns dictionary name (like "old English" or so)
     QString name() const;
 
-    //! \returns dictionary type (xdxf, google translate, etc)
+    //! \returns dictionary type (xdxf, google,starDict translate, etc)
     QString type() const;
 
     //! returns information about dictionary in xml (name, authors, etc)
@@ -84,7 +84,8 @@ public:
         return search(key, 0, 0);
     }
 
-    /*! \return a description of a word given by a QString
+    /*!
+        \return a description of a word given by a QString
         \param offset offset of translation to be cut out
         \param len lenght of translation to be cut out
     */
@@ -102,7 +103,8 @@ public:
     //! \returns plugin icon
     QIcon* icon();
 
-    /*! plugin should delete any files (eg. cache) that have been created and are ready
+    /*!
+        plugin should delete any files (eg. cache) that have been created and are ready
         to be deleted
     */
     void clean();
@@ -130,8 +132,8 @@ public Q_SLOTS:
 private:
 
     /*!
-        searches for a list of words similar to a word in a database file
-        \param word key compared with keys in a database
+        searches for a list of words similar to a word in file
+        \param word key compared with keys in a file
         \param limit limits the number of translations in returned list,
         0 means unlimited
         \returns list of translations
@@ -139,8 +141,8 @@ private:
     QList<Translation*> searchWordListCache(QString word, int limit=0);
 
     /*!
-        searches for a list of words similar to a word in a xdxf file
-        \param word key compared with keys in a xdxf file
+        searches for a list of words similar to a word in a starDict file
+        \param word key compared with keys in a starDict file
         \param limit limits the number of translations in returned list,
         0 means unlimited
         \returns list of translations
@@ -149,14 +151,14 @@ private:
 
     /*!
         searches for a translation of a word which is exactly like a key
-        in a xdxf file
+        in a starDict file
     */
     QString searchFile(QString key);
 
     //! scans dictionary file to get information about it
     bool getDictionaryInfo();
 
-    //! counts the keys in a xdxf file
+    //! counts the keys in a starDict file
     int countWords();