Merge branch 'master' into google

[mdictionary] / src / plugins / google / GooglePlugin.h

diff --git a/src/plugins/google/GooglePlugin.h b/src/plugins/google/GooglePlugin.h
index c6e201f..01097bb 100644 (file)
--- a/src/plugins/google/GooglePlugin.h
+++ b/src/plugins/google/GooglePlugin.h
@@ -50,16 +50,16 @@ public:
     GooglePlugin(QObject *parent=0);
     ~GooglePlugin();
 
-    //! 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;
 
     //! returns information about dictionary (name, authors, etc)
@@ -71,36 +71,36 @@ public:
     //! sets the language from which the translation is done
     void setLangFrom(QString langFrom);
 
-    /*! returns DictDialog object that creates dialogs
+    /*! \returns DictDialog object that creates dialogs
         for adding new dictionaries and changing plugin things
       */
     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;
 
     //! sets if connection with Internet is possible
     void setConnectionAccept(QString connectionAcepted);
 
-    //! returns the value of "connection_accepted" from settings
+    //! \returns the value of "connection_accepted" from settings
     bool isConnectionAccept() 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();
 
     //! Sets new settings
     void setSettings(const Settings*);
 
-    //! returns plugin icon
+    //! \returns plugin icon
     QIcon* icon();
 
-    //! returns empty translation object (to be fetched later) for given key
+    //! \returns empty translation object (to be fetched later) for a given key
     Translation* getTranslationFor(QString key);
 
     //! initializes the list of available languages in Google translator
@@ -118,7 +118,7 @@ public slots:
     */
     QList<Translation*> searchWordList(QString word, int limit=0);
 
-    //! stop current operation
+    //! stops current operation
     void stop();
 
     //! function called after the request from Google is returned
@@ -141,7 +141,7 @@ private:
     //! information about dictionary
     QString _infoNote;
 
-    //! icon displayed during translations and when the dictionary is chosen
+    //! icon displayed during translations and when a dictionary is chosen
     QIcon _icon;
     Settings *_settings;
     //! indicates if search is stopped