From 777ceddc1db28876eaa5f72fba292f7cc6336f43 Mon Sep 17 00:00:00 2001
From: Matthew Fernandez <matthew.fernandez@gmail.com>
Date: Sat, 18 Jul 2020 12:11:11 -0700
Subject: [PATCH] expand on vmclear description

---
 lib/vmalloc/vmclear.c | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/lib/vmalloc/vmclear.c b/lib/vmalloc/vmclear.c
index d512cebbd..44a31e650 100644
--- 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;
 
-- 
2.40.0