From 5f34bb285271814cf37fa151d1a14e037fa2a224 Mon Sep 17 00:00:00 2001 From: Jeremy Paul Whiting Date: Wed, 29 Aug 2007 02:15:27 +0000 Subject: [PATCH] apidox fixes svn path=/trunk/KDE/kdeedu/libkdeedu/; revision=705967 --- keduvocdocument/keduvocgrade.h | 144 ++++++++++----------------- keduvocdocument/keduvoctranslation.h | 2 +- keduvocdocument/sharedkvtmlfiles.cpp | 4 - 3 files changed, 53 insertions(+), 97 deletions(-) diff --git a/keduvocdocument/keduvocgrade.h b/keduvocdocument/keduvocgrade.h index 89a5ac7..ca3ccc6 100644 --- a/keduvocdocument/keduvocgrade.h +++ b/keduvocdocument/keduvocgrade.h @@ -59,62 +59,43 @@ Contains grading information (query date, bad count) for one language with respe class KEDUVOCDOCUMENT_EXPORT KEduVocGrade { public: + /** default constructor */ KEduVocGrade(); /** copy constructor * provides safe copy of d pointer + * @param other object to copy from */ KEduVocGrade(const KEduVocGrade &other); + /** default destructor */ ~KEduVocGrade(); - /** returns query count of given translation as int - * - * @param index index of translation - * @param index the identifier displayed to the user - - */ - count_t queryCount( ) const; - - /** set query count of given translation as int - * - * @param index index of translation - * @param index the identifier displayed to the user - * @param count the new count - - */ - void setQueryCount( count_t count ); - - /** returns bad query count of given translation as int - * - * @param index index of translation - * @param index the identifier displayed to the user - * @param reverse dito, in opposite direction - */ - count_t badCount( ) const; - - /** set bad query count of given translation as int - * - * @param index index of translation - * @param index the identifier displayed to the user - * @param count the new count - */ - void setBadCount( count_t count ); - - /** increment bad query count of given translation by 1 - * - * @param index index of translation - * @param index the identifier displayed to the user - */ - void incBadCount( ); - - /** increment query count of given translation by 1 - * - * @param index index of translation - * @param index the identifier displayed to the user - - */ - void incQueryCount( ); + /** returns query count as int + * @returns query count + */ + count_t queryCount( ) const; + + /** set query count as int + * @param count the new count + */ + void setQueryCount( count_t count ); + + /** returns bad query count as int + * @returns bad query count + */ + count_t badCount( ) const; + + /** set bad query count as int + * @param count the new count + */ + void setBadCount( count_t count ); + + /** increment bad query count of given translation by 1 */ + void incBadCount( ); + + /** increment query count of given translation by 1 */ + void incQueryCount( ); /** @@ -122,51 +103,30 @@ public: */ void resetGrades(); - /** sets grade of given translation - * - * @param index index of translation - * @param index the identifier displayed to the user - * @param grade number of knowlegde: 0=known, x=numbers not knows - */ - void setGrade( grade_t grade ); - - /** returns grade of given translation as int - * - * @param index index of translation - * @param index the identifier displayed to the user - * @return number of knowlegde: 0=known, x=numbers not knows - */ - grade_t grade() const; - - /** increments grade of given translation - * - * @param index index of translation - * @param index the identifier displayed to the user - - */ - void incGrade( ); - - /** decrements grade of given translation - * - * @param index index of translation - * @param index the identifier displayed to the user - - */ - void decGrade( ); - - /** returns last query date of given translation as int - * - * @param index index of translation - * @param index the identifier displayed to the user - */ - QDateTime queryDate( ) const; - - - /** - * Set last query date - * @param index index of translation - * @param date the new date - */ + /** sets the grade + * @param grade number of knowlegde: 0=known, x=numbers not knows + */ + void setGrade( grade_t grade ); + + /** returns grade of given translation as int + * @returns number of knowlegde: 0=known, x=numbers not knows + */ + grade_t grade() const; + + /** increments grade of given translation */ + void incGrade( ); + + /** decrements grade of given translation */ + void decGrade( ); + + /** returns last query date of given translation as int + */ + QDateTime queryDate( ) const; + + + /** Set last query date + * @param date the new date + */ void setQueryDate ( const QDateTime & date ); private: diff --git a/keduvocdocument/keduvoctranslation.h b/keduvocdocument/keduvoctranslation.h index d4c6b40..02a7ba8 100644 --- a/keduvocdocument/keduvoctranslation.h +++ b/keduvocdocument/keduvoctranslation.h @@ -86,7 +86,7 @@ public: void setComment( const QString & expr); /** sets false friend of this expression - * @param indexint indexFrom index of original translation + * @param indexFrom index of original translation * @param expression false friend of this index */ void setFalseFriend( int indexFrom, const QString & expression ); diff --git a/keduvocdocument/sharedkvtmlfiles.cpp b/keduvocdocument/sharedkvtmlfiles.cpp index 461eaa8..abb5582 100644 --- a/keduvocdocument/sharedkvtmlfiles.cpp +++ b/keduvocdocument/sharedkvtmlfiles.cpp @@ -126,10 +126,6 @@ QStringList SharedKvtmlFiles::fileNames(const QString &language) return language.isEmpty() ? sharedKvtmlFilesPrivate->m_fileList : sharedKvtmlFilesPrivate->m_filesByLang.value(language); } -/** get the list of document titles found of a given language - *@param language requested language - *@return a list of document titles with words in language - */ QStringList SharedKvtmlFiles::titles(const QString &language) { QStringList retlist; -- 2.47.3