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 ec8af37936b71120f06f959452b8558716f273c5..2f753c74a329e33bb389a30d948fd635873b9a84 100644 (file)
--- 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 );