commit b0f9ecdbb138529fb9428121a62e8a5004767761 Author: Nick Mathewson nickm@torproject.org Date: Tue Nov 12 12:09:53 2019 -0500
Move 01g-strings.md into doxygen. --- .../design/01g-strings.md => src/lib/string/strings.dox | 10 +++++++++- src/mainpage.dox | 2 ++ 2 files changed, 11 insertions(+), 1 deletion(-)
diff --git a/doc/HACKING/design/01g-strings.md b/src/lib/string/strings.dox similarity index 92% rename from doc/HACKING/design/01g-strings.md rename to src/lib/string/strings.dox index 145a35cd6..71c982680 100644 --- a/doc/HACKING/design/01g-strings.md +++ b/src/lib/string/strings.dox @@ -1,5 +1,6 @@ +/**
-## String processing in Tor ## +@page strings String processing in Tor
Since you're reading about a C program, you probably expected this section: it's full of functions for manipulating the (notoriously @@ -77,6 +78,11 @@ full of substrings in order. Then you can concatenate them into a single string with smartlist_join_strings(), which also takes optional separator and terminator arguments.
+Alternatively, you might find it more convenient (and more +allocation-efficient) to use the buffer API in buffers.c: Construct a buf_t +object, add your data to it with buf_add_string(), buf_add_printf(), and so +on, then call buf_extract() to get the resulting output. + As a convenience, we provide smartlist_add_asprintf(), which combines the two methods above together. Many of the cryptographic digest functions also accept a not-yet-concatenated smartlist of strings. @@ -93,3 +99,5 @@ you can use hex_str(memory, length) for that.
The escaped() and hex_str() functions both provide outputs that are only valid till they are next invoked; they are not threadsafe. + +*/ diff --git a/src/mainpage.dox b/src/mainpage.dox index a568d52fc..4f565cf6e 100644 --- a/src/mainpage.dox +++ b/src/mainpage.dox @@ -36,6 +36,8 @@ Tor repository.
@subpage threading
+@subpage strings + **/
/**