From: Adriaan de Groot <groot@kde.org>
Date: Tue, 25 Oct 2005 19:16:14 +0000 (+0000)
Subject: dox fixes: watering can, mostly missing @param names.
X-Git-Tag: v3.80.2~237^2~4
X-Git-Url: https://git.rmz.fi/?a=commitdiff_plain;h=551f43644d429c60a8a94a2f66735fcefc0503c6;p=libqmvoc.git

dox fixes: watering can, mostly missing @param names.

svn path=/trunk/KDE/kdeedu/kwordquiz/src/keduvocexpression.h; revision=474230
---

diff --git a/kwordquiz/keduvocexpression.h b/kwordquiz/keduvocexpression.h
index 7717799..8995bd1 100644
--- a/kwordquiz/keduvocexpression.h
+++ b/kwordquiz/keduvocexpression.h
@@ -139,14 +139,14 @@ class KEduVocExpression
   /** sets translation of this expression
    *
    * @param index            number of translation
-   * @param expr             expression of this index
+   * @param expression       expression of this index
    */
   void setTranslation(int index, const QString & expression);
 
   /** sets pronounciation of this expression
    *
    * @param index            index of expression
-   * @param expr             pronounciation of this index
+   * @param expression       pronounciation of this index
    */
   void setPronounciation(int index, const QString & expression);
 
@@ -192,7 +192,7 @@ class KEduVocExpression
   /** sets synonym this expression
    *
    * @param index            index of expression
-   * @param expr             synonym of this index
+   * @param expression       synonym of this index
    */
   void setSynonym(int index, const QString & expression);
 
diff --git a/kwordquiz/leitnersystem.h b/kwordquiz/leitnersystem.h
index c7ed882..c95ed4b 100644
--- a/kwordquiz/leitnersystem.h
+++ b/kwordquiz/leitnersystem.h
@@ -58,31 +58,32 @@ public:
 	void setSystemName( const QString& name );
 
 	/**Returns a LeitnerBox by number
-	 * @param the number of the LeitnerBox to be returned
+	 * @param number the number of the LeitnerBox to be returned
 	 * @return a pointer to the LeitnerBox with the number
 	 */
 	LeitnerBox* boxWithNumber( int number );
 
 	/**Returns a LeitnerBox by name
-	 * @param the name of the LeitnerBox to be returned
-	 * @return a pointer to the LeitnerBox with the name
+	 * @param name the name of the LeitnerBox to be returned
+	 * @return a pointer to the LeitnerBox with the name,
+	 *         or 0 if no such box exists.
 	 */
 	LeitnerBox* boxWithName( const QString& name ) const;
 
 	/**Returns the number of the given LeitnerBox
-	 * @param a pointer to the LeitnerBox
+	 * @param box a pointer to the LeitnerBox
 	 * @return the number of the given LeitnerBox
 	 */
 	int number( LeitnerBox* box ) const;
 
-	/**Returns the name of the LeitnerBox with number @param i
-	 * @param the LeitnerBox's number
-	 * @return the name of the LeitnerBox with number @param i
+	/**Returns the name of the LeitnerBox with number @p i
+	 * @param i the LeitnerBox's number
+	 * @return the name of the LeitnerBox with number @p i
 	 */
 	const QString& box( int i ) const;
 
-	/**Returns the LeitnerBox following @param previousBox
-	 * @param the name of the LeitnerBox
+	/**Returns the LeitnerBox following @p previousBox
+	 * @param previousBox the name of the LeitnerBox
 	 * @return the name of the LeitnerBox following previousBox
 	 */
 	const QString& nextBox( QString& previousBox );