aboutsummaryrefslogtreecommitdiff
path: root/src/lib/string/lib_string.md
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-11-15 09:27:26 -0500
committerNick Mathewson <nickm@torproject.org>2019-11-15 09:28:12 -0500
commit8b91680d5c57fc35275b32aea57555d8ef7d61ba (patch)
tree5040bae10d88ba7810d5c9b5517e1e355a080f11 /src/lib/string/lib_string.md
parent3a7369d0cfa567cdb02063e1dad176c92ef2c7fe (diff)
downloadtor-8b91680d5c57fc35275b32aea57555d8ef7d61ba.tar.gz
tor-8b91680d5c57fc35275b32aea57555d8ef7d61ba.zip
Doxygen: rename all .dox files to end with .md
Using a standard ending here will let other tools that expect markdown understand our output here. This commit was automatically generated with: for fn in $(find src -name '*.dox'); do \ git mv "$fn" "${fn%.dox}.md"; \ done
Diffstat (limited to 'src/lib/string/lib_string.md')
-rw-r--r--src/lib/string/lib_string.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/lib/string/lib_string.md b/src/lib/string/lib_string.md
new file mode 100644
index 0000000000..98e3e652ed
--- /dev/null
+++ b/src/lib/string/lib_string.md
@@ -0,0 +1,13 @@
+@dir /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.