Added comments for StarDictReaders

[mdictionary] / src / plugins / stardict / StarDictReaderFactory.h

diff --git a/src/plugins/stardict/StarDictReaderFactory.h b/src/plugins/stardict/StarDictReaderFactory.h
index e5f5e93..a6e12e3 100644 (file)
--- a/src/plugins/stardict/StarDictReaderFactory.h
+++ b/src/plugins/stardict/StarDictReaderFactory.h
@@ -25,9 +25,14 @@
 #define STARDICTREADERFACTORY_H
 #include "StarDictReader.h"
 
+/*!
+  Class used to creating StarDictReader objects, based on filename it creates
+  compressed or uncompressed reader.
+  */
 class StarDictReaderFactory
 {
 public:
+    //! Creates new StarDictReader suitable for passed file
     static StarDictReader* createReader(QString file);
 };