Clarified apidox

svn path=/trunk/KDE/kdeedu/libkdeedu/; revision=526904

diff --git a/kdeeducore/keduvocexpression.cpp b/kdeeducore/keduvocexpression.cpp
index f64c0d20843ee1c7cbda7921396bfe441f632a03..eed7a07c38d9721686954a33d27d73ff257118af 100644 (file)
--- a/kdeeducore/keduvocexpression.cpp
+++ b/kdeeducore/keduvocexpression.cpp
@@ -34,26 +34,23 @@ void KEduVocExpression::Init()
   m_lesson = 0;
 }
 
-
-KEduVocExpression::KEduVocExpression(const QString & expression, int lesson)
+KEduVocExpression::KEduVocExpression ()
 {
   Init();
-  setOriginal(expression.simplified() );
-  m_lesson = lesson;
 }
 
-
-KEduVocExpression::KEduVocExpression ()
+KEduVocExpression::KEduVocExpression(const QString & expression, int lesson)
 {
   Init();
+  setOriginal(expression.simplified() );
+  m_lesson = lesson;
 }
 
-
-KEduVocExpression::KEduVocExpression(const QString &s, const QString & separator, int lesson)
+KEduVocExpression::KEduVocExpression(const QString & expression, const QString & separator, int lesson)
 {
   Init();
   QString se;
-  QString expr = s;
+  QString expr = expression;
   m_lesson = lesson;
 
   if (separator.length() ) {
@@ -80,12 +77,6 @@ KEduVocExpression::KEduVocExpression(const QString &s, const QString & separator
   }
 }
 
-
-KEduVocExpression::~KEduVocExpression()
-{
-}
-
-
 int KEduVocExpression::numTranslations() const
 {
   return m_translations.count();

diff --git a/kdeeducore/keduvocexpression.h b/kdeeducore/keduvocexpression.h
index f5375c2c189da123e4618e523a7456d6029f629e..bb4d91bda200c6c3bd0a39e609c60e2179a575f0 100644 (file)
--- a/kdeeducore/keduvocexpression.h
+++ b/kdeeducore/keduvocexpression.h
@@ -58,28 +58,32 @@ typedef signed char grade_t;
 typedef unsigned short count_t;
 
 /**
-  This class contains one expression either as an original or as a
-  translation
+  This class contains one vocabulary expression as an original with one or more
+  translations
   */
 
 class KEduVocExpression
 {
- public:
+public:
 
-  /** default constructor for an expression in different languages
+  /** default constructor for an empty vocabulary expression
    */
-  ~KEduVocExpression ();
-
   KEduVocExpression ();
 
-  KEduVocExpression(const QString & s, const QString & separator, int lesson = 0);
+  /** Constructor for a vocabulary expression with an original
+   *
+   * @param expression       original
+   * @param lesson           lesson number, 0 for none
+   */
+  KEduVocExpression(const QString & expression, int lesson = 0);
 
-  /** Constructor for an expression in different languages
+  /** Constructor for a vocabulary expression with an original and one or more translations
    *
    * @param expression       expression
+   * @param separator        expression will be split into an original and one or more translations using separator
    * @param lesson           lesson number, 0 for none
    */
-  KEduVocExpression(const QString & expression, int lesson = 0);
+  KEduVocExpression(const QString & expression, const QString & separator, int lesson = 0);
 
   /** adds a new translation of this entry
    * @param expression       translation