expand on vmclear description

diff --git a/lib/vmalloc/vmclear.c b/lib/vmalloc/vmclear.c
index d512cebbd37cb51f2ad114ae83caa3560e37982e..44a31e65044a10902b49447ecd7c85412a81ae1d 100644 (file)
--- a/lib/vmalloc/vmclear.c
+++ b/lib/vmalloc/vmclear.c
@@ -12,10 +12,14 @@
 #include "vmalloc.h"
 #include <stdlib.h>
 
-/*     Clear out all allocated space.
-**
-**     Written by Kiem-Phong Vo, kpv@research.att.com, 01/16/94.
-*/
+/** Clear out all allocated space.
+ *
+ * Note that this leaves the allocation region itself usable, but just frees all
+ * previous allocations made within this region.
+ *
+ * @param vm Vmalloc to operate on
+ * @returns 0 on success
+ */
 int vmclear(Vmalloc_t *vm) {
   size_t i;