[kaffe] CVS kaffe (robilad): documented helper function soft_dcmp

[Kaffe CVS]

PatchSet 7740 
Date: 2008/02/11 21:49:57
Author: robilad
Branch: HEAD
Tag: (none) 
Log:
documented helper function soft_dcmp

2008-02-11  Dalibor Topic  <robilad at kaffe.org>

* kaffe/kaffevm/soft.c (soft_dcmp): Documented.

Members: 
	ChangeLog:1.5240->1.5241 
	kaffe/kaffevm/soft.c:1.84->1.85 

Index: kaffe/ChangeLog
diff -u kaffe/ChangeLog:1.5240 kaffe/ChangeLog:1.5241
--- kaffe/ChangeLog:1.5240	Mon Feb 11 21:44:41 2008
+++ kaffe/ChangeLog	Mon Feb 11 21:49:57 2008
@@ -1,5 +1,9 @@
 2008-02-11  Dalibor Topic  <robilad at kaffe.org>
 
+	* kaffe/kaffevm/soft.c (soft_dcmp): Documented.
+
+2008-02-11  Dalibor Topic  <robilad at kaffe.org>
+
 	* kaffe/kaffevm/soft.c (soft_dcmp): New function.
 	Implements dcmpl/dcmpg according to VM spec.
 	(soft_dcmpl, soft_dcmpg) Call soft_dcmp.
Index: kaffe/kaffe/kaffevm/soft.c
diff -u kaffe/kaffe/kaffevm/soft.c:1.84 kaffe/kaffe/kaffevm/soft.c:1.85
--- kaffe/kaffe/kaffevm/soft.c:1.84	Mon Feb 11 21:44:43 2008
+++ kaffe/kaffe/kaffevm/soft.c	Mon Feb 11 21:49:59 2008
@@ -627,6 +627,15 @@
 }
 
 
+/**
+ * dcmp helper function.
+ *
+ * @param v1 left side value
+ * @param v2 right side value
+ * @param nan return value in case v1 or v2 is NaN
+ *
+ * @return 1 if v1 > v2, 0 if v1 == v2, -1 if v1 < v2, otherwise nan.
+ */
 static
 jint
 soft_dcmp(const jdouble v1, const jdouble v2, const jint nan)