summaryrefslogtreecommitdiff
path: root/src/lib/log/lib_log.dox
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/log/lib_log.dox')
-rw-r--r--src/lib/log/lib_log.dox10
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.
+
+
**/