From 6f267b3968d54f8bcd41d584a71bef9020ff773e Mon Sep 17 00:00:00 2001
From: ZyX <kp-pav@yandex.ru>
Date: Sat, 7 Jan 2017 17:58:29 +0300
Subject: memory: Document new additions to memory.h

---
 src/nvim/memory.c |  1 -
 src/nvim/memory.h | 17 +++++++++++++++++
 2 files changed, 17 insertions(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/nvim/memory.c b/src/nvim/memory.c
index a5045dfffc..92ead873ae 100644
--- a/src/nvim/memory.c
+++ b/src/nvim/memory.c
@@ -49,7 +49,6 @@ MemRealloc mem_realloc = &realloc;
 #endif
 
 #ifdef EXITFREE
-/// Indicates that free_all_mem function was or is running
 bool entered_free_all_mem = false;
 #endif
 
diff --git a/src/nvim/memory.h b/src/nvim/memory.h
index d82972cffc..f65947d449 100644
--- a/src/nvim/memory.h
+++ b/src/nvim/memory.h
@@ -5,17 +5,34 @@
 #include <stddef.h>  // for size_t
 #include <time.h>    // for time_t
 
+/// `malloc()` function signature
 typedef void *(*MemMalloc)(size_t);
+
+/// `free()` function signature
 typedef void (*MemFree)(void *);
+
+/// `calloc()` function signature
 typedef void *(*MemCalloc)(size_t, size_t);
+
+/// `realloc()` function signature
 typedef void *(*MemRealloc)(void *, size_t);
 
+#ifdef UNIT_TESTING
+/// When unit testing: pointer to the `malloc()` function, may be altered
 extern MemMalloc mem_malloc;
+
+/// When unit testing: pointer to the `free()` function, may be altered
 extern MemFree mem_free;
+
+/// When unit testing: pointer to the `calloc()` function, may be altered
 extern MemCalloc mem_calloc;
+
+/// When unit testing: pointer to the `realloc()` function, may be altered
 extern MemRealloc mem_realloc;
+#endif
 
 #ifdef EXITFREE
+/// Indicates that free_all_mem function was or is running
 extern bool entered_free_all_mem;
 #endif
 
-- 
cgit