aboutsummaryrefslogtreecommitdiff
path: root/src/lib/memarea
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/memarea')
-rw-r--r--src/lib/memarea/lib_memarea.dox8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/lib/memarea/lib_memarea.dox b/src/lib/memarea/lib_memarea.dox
index dbd98de5ec..f5b44f97c2 100644
--- a/src/lib/memarea/lib_memarea.dox
+++ b/src/lib/memarea/lib_memarea.dox
@@ -1,4 +1,10 @@
/**
@dir lib/memarea
-@brief lib/memarea
+@brief lib/memarea A fast arena-style allocator.
+
+This module has a fast "arena" style allocator, where memory is freed all at
+once. This kind of allocation is very fast and avoids fragmentation, at the
+expense of requiring all the data to be freed at the same time. We use this
+for parsing and diff calculations.
+
**/