From: Carsten Niehaus <cniehaus@gmx.de>
Date: Wed, 6 Jul 2005 17:11:01 +0000 (+0000)
Subject: apifixes
X-Git-Tag: v3.80.2~300^2~97
X-Git-Url: https://git.rmz.fi/?a=commitdiff_plain;h=f7b4004a3362f2d661fa6e75fac19fcaba7e64a5;p=libqmvoc.git

apifixes

svn path=/trunk/KDE/kdeedu/kalzium/src/element.h; revision=432224
---

diff --git a/kalzium/src/element.h b/kalzium/src/element.h
index 30d732a..d27960c 100644
--- a/kalzium/src/element.h
+++ b/kalzium/src/element.h
@@ -134,7 +134,7 @@ struct coordinate{
 };
 
 /**
- * In this class all information available are stored. This means that
+ * In this class all information about an element are stored. This means that
  * both the chemical date and the data about the position are stored
  * in this class.
  * @short This class is the represention of a chemical element
@@ -388,10 +388,10 @@ class Element{
 
 		/**
 		 * adjusts the units for the data. The user can
-		 * eg define if Fahrenheit, Kelvin or Degrees Celsius
-		 * should be used for the temperature. This method
-		 * takes care of that.
-		 * @param val the value which has to be adjusted
+		 * for example define if Fahrenheit, Kelvin or 
+		 * Degrees Celsius should be used for the temperature. 
+		 * This method takes care of that and adjust the 
+		 * values.
 		 * @param type the TYPE of the data
 		 * @return the adjusted datastring
 		 */
@@ -399,9 +399,16 @@ class Element{
 
 		const QString adjustRadius( RADIUSTYPE rtype );
 
-
 		/**
-		 * needed for values stored in a QValueList<double>
+		 * adjusts the units for the data. The user can
+		 * for example define if Fahrenheit, Kelvin or 
+		 * Degrees Celsius should be used for the temperature. 
+		 * This method takes care of that and adjust the 
+		 * values. Depending on @p type a unit will be
+		 * added to the adjusted value.
+		 * @param type the TYPE of the data
+		 * @param value the value of the data. 
+		 * @return the adjusted datastring
 		 */
 		const QString adjustUnits( const int type, double value );