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/log | |
| 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/log')
| -rw-r--r-- | src/lib/log/lib_log.dox | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/src/lib/log/lib_log.dox b/src/lib/log/lib_log.dox index 915d652407..5059f3ef73 100644 --- a/src/lib/log/lib_log.dox +++ b/src/lib/log/lib_log.dox @@ -1,4 +1,12 @@ /** @dir lib/log -@brief lib/log +@brief lib/log: Log messages to files, syslogs, etc. + +You can think of this as the logical "midpoint" of the +\ref src/lib "library code": much of the higher-level code is higher-level +_because_ it uses the logging module, and much of the lower-level code is +specifically written to avoid having to log, because the logging module +depends on it. + + **/ |