detect a disconect error in GooglePlugin

[mdictionary] / trunk / src / plugins / google / src / GoogleSettingsDialog.h

diff --git a/trunk/src/plugins/google/src/GoogleSettingsDialog.h b/trunk/src/plugins/google/src/GoogleSettingsDialog.h
index 7344427..1113904 100644 (file)
--- a/trunk/src/plugins/google/src/GoogleSettingsDialog.h
+++ b/trunk/src/plugins/google/src/GoogleSettingsDialog.h
@@ -1,3 +1,29 @@
+/*******************************************************************************
+
+    This file is part of mDictionary.
+
+    mDictionary is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    mDictionary is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with mDictionary.  If not, see <http://www.gnu.org/licenses/>.
+
+    Copyright 2010 Comarch S.A.
+
+*******************************************************************************/
+
+/*! \file GoogleSettingsDialog.h
+    \brief Class create dialog to get or change settings for Google Plagin
+    \author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
+*/
+
 #ifndef GOOGLESETTINGSDIALOG_H
 #define GOOGLESETTINGSDIALOG_H
 
@@ -14,9 +40,25 @@ class GoogleSettingsDialog : public QDialog
 public:
     explicit GoogleSettingsDialog(QWidget *parent = 0,QString langTo ="",QString langFrom ="");
 
+    /*!
+        \param parent parent widget on which will be displayed dialog
+        \param langTo language witch is display in the comboBox as a startup item
+        \param langFrom language witch is display in the comboBox as a startup item
+        \returns function return settings to GooglePlugin
+    */
     static Settings* getSettings(QWidget *parent,QString langTo ="",QString langFrom ="");
+
+    /*!
+        function set a new settings in plugin;
+        \param plugin plugin whose settings you will change
+        \param parent parent widget on which will be displayed dialog
+    */
     static void changeSettings(GooglePlugin* plugin, QWidget *parent);
+
+    //! \return source language code iso 639-2
     QString langFrom();
+
+    //! \return destination language code iso 639-2
     QString langTo();
 
 public slots: