Added some doc for StarDict dict file interpretation

diff --git a/src/plugins/stardict/StarDictPlugin.h b/src/plugins/stardict/StarDictPlugin.h
index eba7ad0..632ecdc 100644 (file)
--- a/src/plugins/stardict/StarDictPlugin.h
+++ b/src/plugins/stardict/StarDictPlugin.h
@@ -184,11 +184,31 @@ private:
     StarDictDialog* _dictDialog;
     Settings* _ifoFileSettings;
     StarDictReader * dictReader;
+
+    /*! Reads and process (converting to qstring) data from StarDict dictionary
+        file (*.dict[.dz])
+        \return converted translation
+        \param QByteArray raw data to process
+        \param mode StarDict parametr "sametypesequence" */
     QString format(QByteArray, QString mode);
-    QByteArray read(QByteArray::iterator, QByteArray::iterator end,
+
+    /*! Reads bytes bytes of data or reads until \0
+        \param it iterator to given data
+        \param end end of data
+        \param bytes to read
+        \return readed data chunk*/
+    QByteArray read(QByteArray::iterator it, QByteArray::iterator end,
            int bytes = 0);
-    QString interpret(QByteArray::iterator, QByteArray::iterator,
-            QChar, bool last = false);
+
+    /*! Interpret data basis on mode (StarDict dict data type)
+        \param it iterator on given data set
+        \param end iterator pointing to the data end
+        \param mode stardict dict data type
+        \param last used to interpret sametypesequence field last letter (see
+                StarDict format description)
+        \return QSting containing interpreted data chunk */
+    QString interpret(QByteArray::iterator it, QByteArray::iterator end,
+            QChar mode, bool last = false);
 };
 
 #endif // XDXFPLUGIN_H