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/err | |
| 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/err')
| -rw-r--r-- | src/lib/err/lib_err.dox | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/src/lib/err/lib_err.dox b/src/lib/err/lib_err.dox index 8994fa5fd8..23f9d9d3a7 100644 --- a/src/lib/err/lib_err.dox +++ b/src/lib/err/lib_err.dox @@ -1,4 +1,15 @@ /** @dir lib/err -@brief lib/err +@brief lib/err: Lowest-level error handling code. + +This module is responsible for generating stack traces, handling raw +assertion failures, and otherwise reporting problems that might not be +safe to report via the regular logging module. + +There are three kinds of users for the functions in this module: + * Code that needs a way to assert(), but which cannot use the regular + `tor_assert()` macros in logging module. + * Code that needs signal-safe error reporting. + * Higher-level error handling code. + **/ |