From 83e95b272e7a38e986577a485de04d8841e047cc Mon Sep 17 00:00:00 2001 From: jakub Date: Thu, 18 Nov 2010 11:28:02 +0100 Subject: [PATCH] change comments in starDict --- src/plugins/stardict/StarDialog.h | 6 +----- src/plugins/stardict/StarDictDialog.h | 4 ++-- src/plugins/stardict/StarDictPlugin.h | 20 +++++++++++--------- 3 files changed, 14 insertions(+), 16 deletions(-) diff --git a/src/plugins/stardict/StarDialog.h b/src/plugins/stardict/StarDialog.h index de3ed04..babd8c0 100644 --- a/src/plugins/stardict/StarDialog.h +++ b/src/plugins/stardict/StarDialog.h @@ -40,10 +40,6 @@ When adding a new dictionary dialog contains a button to browse file system and select a dictionary file. When changing settings dialog displays basic information about dictionary i. e. name, languages and license info. - In both types of dialogs there are comboboxes with "cache" and "remove accents" - options. On maemo right next to comboboxes are tool buttons which allow to - see more information about these options, on desktop the same information is - displayed as a tool tip. All contents of a dialog are in a scroll area. */ class StarDialog : public QDialog @@ -61,7 +57,7 @@ public: //! Constructor /*! - Creates new xdxf dialog + Creates new StarDict dialog \param plugin if created dialog is of type Change it must be set to point to plugin whose settings will be changed \param type describes type of created dialog diff --git a/src/plugins/stardict/StarDictDialog.h b/src/plugins/stardict/StarDictDialog.h index 99f581b..645c01f 100644 --- a/src/plugins/stardict/StarDictDialog.h +++ b/src/plugins/stardict/StarDictDialog.h @@ -30,13 +30,13 @@ class StarDictPlugin; -//! Implementation of DictDialog interface for xdxf plugin +//! Implementation of DictDialog interface for starDict plugin class StarDictDialog : public DictDialog { Q_OBJECT public: explicit StarDictDialog(StarDictPlugin* plugin, QObject *parent = 0); /*! - Shows "add new xdxf dictionary" dialog and returns settings of a new dict + Shows "add new starDict dictionary" dialog and returns settings of a new dict \param parent parent widget on which dialog will be displayed */ Settings* addNewDictionary(QWidget *parent); diff --git a/src/plugins/stardict/StarDictPlugin.h b/src/plugins/stardict/StarDictPlugin.h index 460874e..48bba05 100644 --- 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 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(); -- 1.7.9.5