From: Frederik Gladhorn <gladhorn@kde.org>
Date: Sun, 17 Jun 2007 20:16:01 +0000 (+0000)
Subject: Add apidox.
X-Git-Tag: v3.91.0~9
X-Git-Url: https://git.rmz.fi/?a=commitdiff_plain;h=1a4210e3e66763934a11dd515fbe7849140de6f6;p=libqmvoc.git

Add apidox.

svn path=/trunk/KDE/kdeedu/libkdeedu/; revision=676834
---

diff --git a/kdeeducore/keduvoctranslation.cpp b/kdeeducore/keduvoctranslation.cpp
index 107ac6e..a80763c 100644
--- a/kdeeducore/keduvoctranslation.cpp
+++ b/kdeeducore/keduvoctranslation.cpp
@@ -13,7 +13,6 @@
  *                                                                         *
  ***************************************************************************/
 
-//#include "keduvocexpression.h"
 
 #include "keduvoctranslation.h"
 #include <KDebug>
@@ -324,19 +323,6 @@ void KEduVocTranslation::setQueryDate (  int indexFrom, const QDateTime & date )
 }
 
 
-// bool KEduVocTranslation::uniqueType() const
-// { ///@todo what is this??? I have no clue... help!
-// /*
-//     bool unique = true;
-//     QString type0 = type ( 0 );
-//     for ( int i = 1; i < translationCount(); i++ )
-//         if ( type0 != type ( i ) )
-//             unique = false;
-//     return unique; */
-//     return false;
-// }
-//
-
 QString KEduVocTranslation::type() const
 {
     return m_types;
diff --git a/kdeeducore/keduvoctranslation.h b/kdeeducore/keduvoctranslation.h
index ea6e247..957180f 100644
--- a/kdeeducore/keduvoctranslation.h
+++ b/kdeeducore/keduvoctranslation.h
@@ -36,15 +36,36 @@
 class KDEEDUCORE_EXPORT KEduVocTranslation
 {
 public:
+    /**
+     * Default constructor for an empty translation.
+     */
     KEduVocTranslation( );
+    /**
+     * Constructor
+     * @param translation is used as translation
+     */
     KEduVocTranslation( const QString &translation );
 
+    /**
+     * Destructor
+     */
     ~KEduVocTranslation();
 
+    /**
+     * The translation as string (the word itself)
+     * @return the translation
+     */
     QString translation () const;
+    /**
+     * Sets the translation
+     * @param expr
+     */
     void setTranslation ( const QString & expr );
 
 
+    /**
+     * Clears grading and date information.
+     */
     void resetGrades();
 
 
@@ -168,13 +189,6 @@ public:
    */
   QString type() const;
 
-/// @todo is this still needed? if so rather in KEduVocExpression
-//   /** all langs have same type ?
-//    *
-//    * @return                 true if all have same type
-//    */
-//   bool uniqueType () const;
-
  /** sets type of this expression
    *
    * @param index            index of type
@@ -319,7 +333,17 @@ public:
    */
   void incQueryCount( int indexFrom );
 
+    /**
+     * Equal operator to assing a translation to another one.
+     * @param translation translation to be copied
+     * @return reference to the new translation
+     */
     KEduVocTranslation& operator=(const KEduVocTranslation &translation);
+    /**
+     * Compare two translations, including word type etc.
+     * @param translation
+     * @return true if equal
+     */
     bool operator==(const KEduVocTranslation &translation) const;
 
 private: