aboutsummaryrefslogtreecommitdiff
path: root/src/lib/string/lib_string.dox
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/string/lib_string.dox')
-rw-r--r--src/lib/string/lib_string.dox13
1 files changed, 12 insertions, 1 deletions
diff --git a/src/lib/string/lib_string.dox b/src/lib/string/lib_string.dox
index 3e038ea072..95645ab368 100644
--- a/src/lib/string/lib_string.dox
+++ b/src/lib/string/lib_string.dox
@@ -1,4 +1,15 @@
/**
@dir lib/string
-@brief lib/string
+@brief lib/string: Low-level string manipulation.
+
+We have a number of compatibility functions here: some are for handling
+functionality that is not implemented (or not implemented the same) on every
+platform; some are for providing locale-independent versions of libc
+functions that would otherwise be defined differently for different users.
+
+Other functions here are for common string-manipulation operations that we do
+in the rest of the codebase.
+
+Any string function high-level enough to need logging belongs in a
+higher-level module.
**/