From: Adriaan de Groot <groot@kde.org>
Date: Mon, 24 Oct 2005 21:08:51 +0000 (+0000)
Subject: Some random dox fixes: keep @param in sync with the parameter names.
X-Git-Tag: v3.80.2~237^2~5
X-Git-Url: https://git.rmz.fi/?a=commitdiff_plain;h=cec8a25749e5b4a1afe7bc29ebdfd5d7748bb471;p=libqmvoc.git

Some random dox fixes: keep @param in sync with the parameter names.

svn path=/trunk/KDE/kdeedu/kwordquiz/src/keduvocdocument.h; revision=473878
---

diff --git a/kwordquiz/keduvocdocument.h b/kwordquiz/keduvocdocument.h
index c41400a..e147ccb 100644
--- a/kwordquiz/keduvocdocument.h
+++ b/kwordquiz/keduvocdocument.h
@@ -267,7 +267,7 @@ class KEduVocDocument : public QObject
 
   /** Constructor for a KdeEdu vocabulary document
    *
-   * @param obj calling object
+   * @param parent calling object
    */
   KEduVocDocument(QObject* parent);
 
@@ -282,14 +282,14 @@ class KEduVocDocument : public QObject
 
   /** appends a new expression to the end of the vocabulary
    *
-   * @param expr            expression to append
+   * @param expression            expression to append
    */
   inline void appendEntry (KEduVocExpression *expression)
     { m_vocabulary.append(*expression); m_dirty = true; }
 
   /** inserts a new expression
    *
-   * @param expr            expression to insert
+   * @param expression            expression to insert
    * @param index           index of entry
    */
   inline void insertEntry(KEduVocExpression *expression, int index)
@@ -437,7 +437,11 @@ class KEduVocDocument : public QObject
 
   /** open a document file
    *
-   * @param url
+   * @param url      url to file to open
+   * @param append   if @c true, the words from @p url are appended to the
+   *                 existing collection; if @c false, the collection is
+   *                 emptied first so that only the words from @p url
+   *                 are in the result.
    * @result         true if successful
    */
   bool open(const KURL& url, bool append);
diff --git a/kwordquiz/keduvocexpression.h b/kwordquiz/keduvocexpression.h
index 2e3087d..7717799 100644
--- a/kwordquiz/keduvocexpression.h
+++ b/kwordquiz/keduvocexpression.h
@@ -83,7 +83,7 @@ class KEduVocExpression
   /** adds a new translation of this entry
    * @param expression       translation
    * @param grade            grade of knowledge of this translation
-   * @param rev_grade        dito, in opposite direction
+   * @param reverseGrade     dito, in opposite direction
    */
   void addTranslation(const QString & expression, grade_t grade = KV_NORM_GRADE, grade_t reverseGrade = KV_NORM_GRADE);