diff options
| author | Nick Mathewson <nickm@torproject.org> | 2019-11-04 10:19:41 -0500 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2019-11-04 10:21:10 -0500 |
| commit | 51a98929148e9ca08b33735fb0542759380c57a9 (patch) | |
| tree | 96951d1d564d4ac379e9feba4a28807c2855e875 /src/lib/memarea | |
| parent | b6b125709998a81d9c9c23d77c6a770ca7a927a7 (diff) | |
| download | tor-51a98929148e9ca08b33735fb0542759380c57a9.tar.gz tor-51a98929148e9ca08b33735fb0542759380c57a9.zip | |
doxygen: Take "lib" descriptions from doc/HACKING/design.
This commit takes descriptions for src/lib and moves them into our
doxygen hierarchy. I've covered everything from lib/cc through
lib/sandbox here.
Diffstat (limited to 'src/lib/memarea')
| -rw-r--r-- | src/lib/memarea/lib_memarea.dox | 8 |
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. + **/ |