Add some documentation to arena.h, fix simplearena_clear not being declared

1 files changed, 26 insertions, 2 deletions

diff --git a/src/arena.h b/src/arena.h
index 331bbb1..1377fa1 100644
--- a/src/arena.h
+++ b/src/arena.h
@@ -7,21 +7,45 @@
 // enables XALLOC functionality
 #define ___VXGG___USE_XALLOC_FOR_ARENAS___ 1
 
+// Normal arena. Can expand in size beyond original allocation
 typedef struct arena arena;
+
+// A wrapper for the normal arena struct. Can not expand in size
 typedef arena simplearena;
 
+// Bitwise operation to check if a number is a power of 2
 #define ISPOWOF2(x) (((x) & ((x) - 1)) == 0)
-static const size_t MEM_ALIGN_BYTES = (2 * sizeof(void*)); // Hey, the static keyword did something for once!
+
+// Variable for memory alignment
+static const size_t MEM_ALIGN_BYTES = (2 * sizeof(void*));
+
+// Macro to get the remaining bytes necessary to be on a power of 2
 #define MEM_ALIGN(x) ((x) + (((x) & (MEM_ALIGN_BYTES - 1)) != 0) * (MEM_ALIGN_BYTES - ((x) & (MEM_ALIGN_BYTES - 1))))
 
+
+// Initialize an arena with `bytes` bytes of pre-allocated memory. Exits / returns NULL on error depending on the value of `___VXGG___USE_XALLOC_FOR_ARENAS___`
 arena * arena_init(size_t bytes);
+
+// Take `bytes` bytes of memory from `arena`'s memory pool. Exits / returns NULL on error depending on the value of `___VXGG___USE_XALLOC_FOR_ARENAS___`
 void * arena_alloc(arena * const arena, size_t bytes);
+
+// Free an arena its memory pool(s). Returns -1 and sets `errno` if the given arena is NULL 
 int arena_free(arena **arena);
+
+// Clear an arena of its contents (frees and inits an arena in 1). Returns -1 and sets `errno` if the given arena is NULL
 int arena_clear(arena **arena);
 
+
+// Initializes a simple arena. 
 simplearena * simplearena_init(size_t bytes);
+
+// Grabs some memory from the simple arena's pool. Exits / returns NULL on error depending on the value of `___VXGG___USE_XALLOC_FOR_ARENAS___`
 void * simplearena_alloc(simplearena * const a, size_t bytes);
+
+// Free a simple arena. Exits / returns -1 on error depending on the value of `___VXGG___USE_XALLOC_FOR_ARENAS___`
 int simplearena_free(simplearena **a);
-int simplearena_free(simplearena **a);
+
+// Clear a simple arena and its memory pool (frees and inits a simple arena in 1). Exits / returns -1 on error depending on the value of `___VXGG___USE_XALLOC_FOR_ARENAS___`
+int simplearena_clear(simplearena **a);
 
 #endif
\ No newline at end of file