add documentation

nouveaus · Jan 15, 2025 · 02e929e · 02e929e
1 parent a81f8b8
commit 02e929e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/kernel/src/arch/x86_64/memory/heap.c b/kernel/src/arch/x86_64/memory/heap.c
@@ -96,7 +96,7 @@ void *kmalloc(size_t size) {
     if (new_address == NULL) return new_address;
     new = allocate_free_block(new_address, size, NULL, before);
     before->next = new;
-    
+
     return get_heap_address(new);
 }
 

diff --git a/kernel/src/arch/x86_64/memory/heap.h b/kernel/src/arch/x86_64/memory/heap.h
@@ -3,6 +3,9 @@
 #include <stdint.h>
 #include <stddef.h>
 
+// Initialises the heap by mapping it in virtual memory.
 void heap_init(uint64_t *pml4);
+// Allocates memory from a specified size.
 void *kmalloc(size_t size);
+// Frees the memory allocated from heap.
 void free(void *address);