Added docstrings and changed file header (license + file doc)

[mdictionary] / trunk / src / includes / translation.h

diff --git a/trunk/src/includes/translation.h b/trunk/src/includes/translation.h
index a157c19..8d4332b 100644 (file)
--- a/trunk/src/includes/translation.h
+++ b/trunk/src/includes/translation.h
@@ -19,7 +19,11 @@
 
 *******************************************************************************/
 
-//Created by Bartosz Szatkowski
+/*! /file translation.h
+\brief Interface for translation instances \see Translation
+
+\author Bartosz Szatkowski <bulislaw@linux.com>
+*/
 
 #ifndef TRANSLATION_H
 #define TRANSLATION_H
@@ -28,7 +32,9 @@
 #include <QMetaType>
 
 
-//! Keeping raw form of translation to be parsed only when needed
+/*! Translation is kind of GoF proxy, it stores key:translation pair and
+  provide it in lazy way -> key is available always, but translation is fetched
+  as late as possible*/
 class Translation {
   public:
     //! \return word to be translated