fill in some missing Javadoc vmalloc comments

diff --git a/lib/vmalloc/vmbest.c b/lib/vmalloc/vmbest.c
index e5c0ea84c4b91e2fd24be44bb60ae5e75d9bee66..0f0f7ea2502ae26262638497e931c86f60623b5d 100644 (file)
--- a/lib/vmalloc/vmbest.c
+++ b/lib/vmalloc/vmbest.c
@@ -39,9 +39,11 @@ static bool make_space(Vmalloc_t *vm) {
   return true;
 }
 
-/**
+/** allocate heap memory
+ *
  * @param vm region allocating from
  * @param size desired block size
+ * @returns Memory fulfilling the allocation request or NULL on failure
  */
 void *bestalloc(Vmalloc_t *vm, size_t size) {
   void *p;
@@ -61,6 +63,12 @@ void *bestalloc(Vmalloc_t *vm, size_t size) {
   return p;
 }
 
+/** free heap memory
+ *
+ * @param vm Region the pointer was originally allocated from
+ * @param data The pointer originally received from vmalloc
+ * @returns 0 on success
+ */
 int bestfree(Vmalloc_t *vm, void *data) {
   size_t i;
 
@@ -88,10 +96,12 @@ int bestfree(Vmalloc_t *vm, void *data) {
   return -1;
 }
 
-/**
+/** resize an area of allocated memory
+ *
  * @param vm region allocation from
  * @param data old block of data
  * @param size new size
+ * @returns Pointer to the newly resized area or NULL on failure
  */
 void *bestresize(Vmalloc_t *vm, void *data, size_t size) {
   size_t i;

diff --git a/lib/vmalloc/vmclose.c b/lib/vmalloc/vmclose.c
index d300370a15a6c9c8dd224447df412b192d6dfae4..abcc4f9a801ac894d13ad42206bcf62c961f2e99 100644 (file)
--- a/lib/vmalloc/vmclose.c
+++ b/lib/vmalloc/vmclose.c
@@ -12,10 +12,11 @@
 #include "vmalloc.h"
 #include <stdlib.h>
 
-/*     Close down a region.
-**
-**     Written by Kiem-Phong Vo, kpv@research.att.com, 01/16/94.
-*/
+/** Close down a region.
+ *
+ * @param vm Vmalloc to operate on
+ * @returns 0 on success
+ */
 int vmclose(Vmalloc_t *vm) {
   int r;
 

diff --git a/lib/vmalloc/vmopen.c b/lib/vmalloc/vmopen.c
index bf959e07f73fe0ec0737cb142b88bf13479eb957..8e185c876464da63a4a3a874e62e5e3c66efb12e 100644 (file)
--- a/lib/vmalloc/vmopen.c
+++ b/lib/vmalloc/vmopen.c
@@ -12,11 +12,10 @@
 #include "vmalloc.h"
 #include <stdlib.h>
 
-/*     Opening a new region of allocation.
-**
-**     Written by Kiem-Phong Vo, kpv@research.att.com, 01/16/94.
-*/
-
+/** Open a new region of allocation.
+ *
+ * @returns A newly allocated Vmalloc or NULL on failure
+ */
 Vmalloc_t *vmopen(void) {
   Vmalloc_t *vm;