From 711dab965fa2f5af93ddd651d6cd6d77575ace9c Mon Sep 17 00:00:00 2001 From: Peter Hedlund Date: Wed, 2 Nov 2005 02:45:35 +0000 Subject: [PATCH] Improved apidox svn path=/trunk/KDE/kdeedu/libkdeedu/; revision=476788 --- kdeeducore/keduvocdocument.h | 7 +++++-- kdeeducore/keduvocexpression.h | 32 ++++++++++++++++++-------------- kdeeducore/leitnersystem.h | 3 ++- 3 files changed, 25 insertions(+), 17 deletions(-) diff --git a/kdeeducore/keduvocdocument.h b/kdeeducore/keduvocdocument.h index ce679f5..2568c82 100644 --- a/kdeeducore/keduvocdocument.h +++ b/kdeeducore/keduvocdocument.h @@ -446,8 +446,11 @@ class KEduVocDocument : public QObject /** saves the data under the given name * - * @param url if url is empty (or NULL) actual name is preserved - * @result true if successful + * @param parent the object that owns the document + * @param url if url is empty (or NULL) actual name is preserved + * @param ft the filetype to be used when saving the document + * @param generator the name of the application saving the document + * @result true if successful */ bool saveAs(QObject *parent, const KURL & url, FileType ft, const QString & generator); diff --git a/kdeeducore/keduvocexpression.h b/kdeeducore/keduvocexpression.h index 07a2c32..a32c7fa 100644 --- a/kdeeducore/keduvocexpression.h +++ b/kdeeducore/keduvocexpression.h @@ -177,7 +177,7 @@ class KEduVocExpression * * @param index index of expression * @param expression false friend of this index - * @param rev_grade dito, in opposite direction + * @param reverse if true, represents the direction translation to original */ void setFauxAmi(int index, const QString & expression, bool reverse = false); @@ -185,7 +185,7 @@ class KEduVocExpression /** returns false friend of this expression * * @param index index of expression - * @param rev_grade dito, in opposite direction + * @param reverse if true, represents the direction translation to original * @return false friend or "" if no string available */ QString fauxAmi(int index, bool reverse = false) const; @@ -287,7 +287,7 @@ class KEduVocExpression /** returns grade of given translation as string * * @param index index of expression - * @param rev_grade dito, in opposite direction + * @param reverse if true, represents the direction translation to original * @return number of knowlegde: 0=known, x=numbers not knows */ QString gradeStr(int index, bool reverse = false) const; @@ -296,13 +296,14 @@ class KEduVocExpression * * @param index index of translation * @param grade number of knowlegde: 0=known, x=numbers not knows + * @param reverse if true, represents the direction translation to original */ void setGrade(int index, grade_t grade, bool reverse = false); /** returns grade of given translation as int * * @param index index of translation - * @param rev_grade dito, in opposite direction + * @param reverse if true, represents the direction translation to original * @return number of knowlegde: 0=known, x=numbers not knows */ grade_t grade(int index, bool reverse = false) const; @@ -310,28 +311,29 @@ class KEduVocExpression /** increments grade of given translation * * @param index index of translation - * @param rev_grade dito, in opposite direction + * @param reverse if true, represents the direction translation to original */ void incGrade(int index, bool reverse = false); /** decrements grade of given translation * * @param index index of translation - * @param rev_grade dito, in opposite direction + * @param reverse if true, represents the direction translation to original */ void decGrade(int index, bool reverse = false); /** returns last query date of given translation as int * * @param index index of translation - * @param rev_date dito, in opposite direction + * @param reverse if true, represents the direction translation to original */ QDateTime queryDate(int index, bool reverse = false) const; /** set last query date of given translation as int * * @param index index of translation - * @param rev_date dito, in opposite direction + * @param date the new date + * @param reverse if true, represents the direction translation to original */ void setQueryDate(int index, const QDateTime & date, bool reverse = false); @@ -344,7 +346,7 @@ class KEduVocExpression /** sets conjugations * * @param index index of translation - * @param conjugator conjugation block + * @param conjugaton conjugation block */ void setConjugation(int index, const KEduVocConjugation & conjugation); @@ -377,14 +379,15 @@ class KEduVocExpression /** returns query count of given translation as int * * @param index index of translation - * @param rev_count dito, in opposite direction + * @param reverse if true, represents the direction translation to original */ count_t queryCount(int index, bool reverse = false) const; /** set query count of given translation as int * * @param index index of translation - * @param reverse dito, in opposite direction + * @param count the new count + * @param reverse if true, represents the direction translation to original */ void setQueryCount(int index, count_t count, bool reverse = false); @@ -398,21 +401,22 @@ class KEduVocExpression /** set bad query count of given translation as int * * @param index index of translation - * @param reverse dito, in opposite direction + * @param count the new count + * @param reverse if true, represents the direction translation to original */ void setBadCount(int index, count_t count, bool reverse = false); /** increment bad query count of given translation by 1 * * @param index index of translation - * @param rev_count dito, in opposite direction + * @param reverse if true, represents the direction translation to original */ void incBadCount(int index, bool reverse = false); /** increment query count of given translation by 1 * * @param index index of translation - * @param rev_count dito, in opposite direction + * @param reverse if true, represents the direction translation to original */ void incQueryCount(int index, bool reverse = false); diff --git a/kdeeducore/leitnersystem.h b/kdeeducore/leitnersystem.h index 173c933..95a953a 100644 --- a/kdeeducore/leitnersystem.h +++ b/kdeeducore/leitnersystem.h @@ -53,7 +53,8 @@ public: QString& systemName(); /**Sets the LeitnerSystem's name - * @param name the new name as QString + * + * @param name the new name as QString */ void setSystemName( const QString& name ); -- 2.47.3