Merge branch 'master' into google

[mdictionary] / src / plugins / xdxf / xdxfplugin.h

diff --git a/src/plugins/xdxf/xdxfplugin.h b/src/plugins/xdxf/xdxfplugin.h
index 4223c08..804d187 100644 (file)
--- a/src/plugins/xdxf/xdxfplugin.h
+++ b/src/plugins/xdxf/xdxfplugin.h
@@ -54,45 +54,49 @@ public:
 
     ~XdxfPlugin();
 
-    //! returns source language code iso 639-2
+    //! \returns source language code iso 639-2
     QString langFrom() const;
 
-    //! returns destination language code iso 639-2
+    //! \returns destination language code iso 639-2
     QString langTo() const;
 
-    //! returns dictionary name (like "old English" or so)
+    //! \returns dictionary name (like "old English" or so)
     QString name() const;
 
-    //! returns dictionary type (xdxf, google translate, etc)
+    //! \returns dictionary type (xdxf, google translate, etc)
     QString type() const;
 
+<<<<<<< HEAD
     //! returns information about dictionary in xml (name, authors, etc)
+=======
+    //! \returns information about dictionary in html (name, authors, etc)
+>>>>>>> master
     QString infoNote() const;
 
-    /*! returns DictDialog object that creates dialogs
-        for adding new dictionary and changing plugin settings
+    /*! \returns DictDialog object that creates dialogs
+        for adding a new dictionary and changing plugin settings
       */
     DictDialog* dictDialog();
 
-    //! returns new, clean copy of plugin with settings set as in Settings*
+    //! \returns new, clean copy of plugin with settings set as in Settings*
     CommonDictInterface* getNew(const Settings*) const;
 
-    //! returns whether plugin can start searching
+    //! \returns whether plugin can start searching
     bool isAvailable() const;
 
-    //! returns a description of a word given by a QString
+    //! \returns a description of a word given by a QString
     QString search(QString key);
 
-    //! returns current plugin settings
+    //! \returns current plugin settings
     Settings* settings();
 
-    //! returns words count in a dictionary
+    //! \returns words count in a dictionary
     long wordsCount();
 
     //! Sets new settings
     bool setSettings(const Settings*);
 
-    //! returns plugin icon
+    //! \returns plugin icon
     QIcon* icon();
 
     /*! plugin should delete any files (eg. cache) that have been created and are ready
@@ -112,7 +116,7 @@ public Q_SLOTS:
     */
     QList<Translation*> searchWordList(QString word, int limit=0);
 
-    //! stop current operation
+    //! stops current operation
     void stop();
 
     //! loads translations for each plugin only once
@@ -126,8 +130,8 @@ Q_SIGNALS:
 
 private:
 
-    /*! returns true or false depending on whether the dictionary is cached
-        or not, not implemented yet
+    /*! \returns true or false depending on whether the dictionary is cached
+        or not
      */
     bool isCached();
     /*! searches for a list of words similar to a word in a database file
@@ -147,17 +151,17 @@ private:
     QList<Translation*> searchWordListFile(QString word, int limit=0);
 
     /*! searches for a translation of a word which is exactly like a key
-        in xdxf file */
+        in a xdxf file */
     QString searchFile(QString key);
 
     /*! searches for a translation of a word which is exactly like a key
-        in database file */
+        in a database file */
     QString searchCache(QString key);
 
     //! scans dictionary file to get information about it
     bool getDictionaryInfo();
 
-    //! counts the keys in xdxf file
+    //! counts the keys in a xdxf file
     int countWords();
 
     /*! transforms xdxf files to database files (caching operation)
@@ -175,7 +179,7 @@ private:
 
     QString _dictionaryInfo;
 
-    //! icon displayed during translations and when the dictionary is chosen
+    //! icon displayed during translations and when a dictionary is chosen
     QIcon _icon;
     QSqlDatabase db;
     QString db_name;