From: Adriaan de Groot <groot@kde.org>
Date: Mon, 24 Oct 2005 11:39:00 +0000 (+0000)
Subject: dox fixes: @param names, and be more verbose about what qstrings unit() takes.
X-Git-Tag: v3.80.2~259
X-Git-Url: https://git.rmz.fi/?a=commitdiff_plain;h=52e4fbf7b9ad011ffc40e1c3344176f1fb7afb97;p=libqmvoc.git

dox fixes: @param names, and be more verbose about what qstrings unit() takes.

svn path=/trunk/KDE/kdeedu/libkdeedu/; revision=473664
---

diff --git a/libscience/chemicaldataobject.h b/libscience/chemicaldataobject.h
index ec8af37..2f753c7 100644
--- a/libscience/chemicaldataobject.h
+++ b/libscience/chemicaldataobject.h
@@ -191,13 +191,23 @@ class ChemicalDataObject
 
 		/**
 		 * set the unit of this object to @p unit
-		 * @param the BlueObeliskUnit of this object
+		 * @param unit the BlueObeliskUnit for this object
 		 */
 		void setUnit( BlueObeliskUnit unit );
 
 		/**
-		 * @return the BlueObeliskUnit of a ChemicalDataObject corresponding to @p text
-		 * @param text the attribute-text of the XML parsed
+		 * Looks up a name @p unitname. The valid names are
+		 * hard-coded in the C++ code, currently
+		 *   - bo:kelvin
+		 *   - bo:ev
+		 *   - bo:nm
+		 *   - bo:pm
+		 *   - bo:noUnit
+		 *
+		 * @return the BlueObeliskUnit of a ChemicalDataObject 
+		 *   corresponding to @p unitname, or noUnit if the name
+		 *   doesn't match any of the known values.
+		 * @param unitname the attribute-text of the XML parsed
 		 */
 		static BlueObeliskUnit unit( const QString& unitname );