From: Anne-Marie Mahfouf Date: Tue, 31 Aug 2010 16:35:57 +0000 (+0000) Subject: typos and cosmetic X-Git-Tag: v4.5.80~7 X-Git-Url: https://git.rmz.fi/?a=commitdiff_plain;h=de4cd481edfc29058ddf08f055562e21fed5cc94;p=libqmvoc.git typos and cosmetic svn path=/trunk/KDE/kdeedu/libkdeedu/; revision=1170349 --- diff --git a/keduvocdocument/Mainpage.dox b/keduvocdocument/Mainpage.dox index 65424d6..1d2adc3 100644 --- a/keduvocdocument/Mainpage.dox +++ b/keduvocdocument/Mainpage.dox @@ -13,7 +13,7 @@ Grammatical terms are part of KEduVocTranslation and also contained in: - KEduVocConjugation (conjugations and personal pronouns) - KEduVocWordType (word type management) -Grammar is accesed by using an instance of KEduVocDocument. +Grammar is accessed by using an instance of KEduVocDocument. Grades can be stored using the KEduVocGrade class (part of a KEduVocTranslation). diff --git a/keduvocdocument/keduvocdocument.h b/keduvocdocument/keduvocdocument.h index 3c9076f..5ca5e66 100644 --- a/keduvocdocument/keduvocdocument.h +++ b/keduvocdocument/keduvocdocument.h @@ -148,42 +148,42 @@ public: KUrl url() const; - /** set the title of the file + /** Set the title of the file * @param title title to set */ void setTitle( const QString & title ); /** @returns the title of the file */ QString title() const; - /** set the author of the file + /** Set the author of the file * @param author author to set */ void setAuthor( const QString & author ); /** @returns the author of the file */ QString author() const; - /** set the author contact info + /** Set the author contact info * @param contact email/contact info to set */ void setAuthorContact( const QString & authorContact ); /** @returns the author contact information */ QString authorContact() const; - /** set the license of the file + /** Set the license of the file * @param license license to set */ void setLicense( const QString & license ); /** @returns the license of the file */ QString license() const; - /** set the comment of the file + /** Set the comment of the file * @param comment comment to set */ void setDocumentComment( const QString & comment ); /** @return the comment of the file */ QString documentComment() const; - /** set the category of the file + /** Set the category of the file * @param category category to set */ void setCategory( const QString & category ); @@ -278,7 +278,7 @@ public: // *** lesson methods *** - /** get the lesson root object + /** Get the lesson root object * @returns a pointer to the lesson object */ KEduVocLesson * lesson(); diff --git a/keduvocdocument/keduvoctranslation.h b/keduvocdocument/keduvoctranslation.h index 520ae77..9038e51 100644 --- a/keduvocdocument/keduvoctranslation.h +++ b/keduvocdocument/keduvoctranslation.h @@ -63,92 +63,92 @@ public: KEduVocExpression* entry(); - /** sets the pronunciation of this expression + /** Sets the pronunciation of this expression * @param expression pronunciation of this index */ void setPronunciation( const QString & expression ); - /** returns the pronunciation of this expression + /** Returns the pronunciation of this expression * @return pronunciation or "" if none available */ QString pronunciation() const; - /** returns comments of this expression + /** Returns comments of this expression * @return comment or "" if no comment available */ QString comment() const; - /** sets comment of this expression + /** Sets comment of this expression * @param expr comment of this index */ void setComment( const QString& expr ); - /** sets example this expression + /** Sets example this expression * @param expression example of this index */ void setExample( const QString & expression ); - /** returns example of this expression + /** Returns example of this expression * @return example or "" if no string available */ QString example() const; - /** sets paraphrase of this expression + /** Sets paraphrase of this expression * @param expression paraphrase of this index */ void setParaphrase( const QString & expression ); - /** returns paraphrase of this expression + /** Returns paraphrase of this expression * @return paraphrase or "" if no string available */ QString paraphrase() const; - /** sets antonym this expression + /** Sets antonym this expression * @param expression antonym of this index */ void setAntonym( const QString & expression ); - /** returns antonym of this expression + /** Returns antonym of this expression * @return antonym or "" if no string available */ QString antonym() const; /** - * Set a irregular plural form. + * Sets an irregular plural form. * @param plural plural of the word */ void setIrregularPlural( const QString& plural ); /** - * Get a irregular plural form. + * Gets an irregular plural form. * @return plural of the word */ QString irregularPlural() const; - /** returns the word type of this expression, you will get a 0 pointer - * if wordtype isn't set for the translation + /** Returns the word type of this expression, you will get a 0 pointer + * if wordtype is not set for the translation * * @return type or "" if no type available */ KEduVocWordType* wordType() const; - /** sets the word type of this expression + /** Sets the word type of this expression * @param type type of this expression ("" = none) */ void setWordType( KEduVocWordType* wordType ); - /** returns the leitner box of this translation + /** Returns the leitner box of this translation * @return the box */ KEduVocLeitnerBox* leitnerBox() const; - /** sets the leitner box of this translation + /** Sets the leitner box of this translation * @param leitnerBox the box */ void setLeitnerBox( KEduVocLeitnerBox* leitnerBox ); /** - * returns a conjugation if available + * Returns a conjugation if available * @param tense tense of the requested conjugation * @return the conjugation */ @@ -203,80 +203,80 @@ public: KEduVocText article() const; void setArticle(const KEduVocText& article); - /** returns multiple choice if available + /** Returns multiple choice if available */ QStringList & multipleChoice(); - /** sets multiple choice + /** Sets multiple choice * @param mc multiple choice block */ // void setMultipleChoice( const QStringList &mc ); - /** get the sound url for this translation if it exists */ + /** Get the sound url for this translation if it exists */ KUrl soundUrl(); - /** set the sound url for this translation + /** Set the sound url for this translation * @param url url of the sound file */ void setSoundUrl(const KUrl &url); - /** get the image url for this translation if it exists */ + /** Get the image url for this translation if it exists */ KUrl imageUrl(); - /** set the image url for this translation + /** Set the image url for this translation * @param url url of the image */ void setImageUrl(const KUrl &url); /** - * add a false friend + * Add a false friend * @param falseFriend false friend of this index */ void addFalseFriend( KEduVocTranslation* falseFriend ); /** - * remove a false friend + * Remove a false friend * @param falseFriend false friend of this index */ void removeFalseFriend( KEduVocTranslation* falseFriend ); /** - * returns false friends of this expression + * Returns false friends of this expression * @return list of false friends */ QList falseFriends() const; /** - * add a synonym + * Add a synonym * @param synonym */ void addSynonym( KEduVocTranslation* synonym ); /** - * remove a synonym + * Remove a synonym * @param synonym */ void removeSynonym( KEduVocTranslation* synonym ); /** - * returns synonyms of this expression + * Returns synonyms of this expression * @return synonyms */ QList synonyms() const; /** - * add a antonym + * Add a antonym * @param antonym */ void addAntonym( KEduVocTranslation* antonym ); /** - * remove a antonym + * Remove a antonym * @param antonym */ void removeAntonym( KEduVocTranslation* antonym ); /** - * returns antonyms of this expression + * Returns antonyms of this expression * @return antonyms */ QList antonyms() const;