[or-cvs] add documentation for smartlist_join_strings

[Nick Mathewson]

Update of /home/or/cvsroot/src/common
In directory moria.mit.edu:/tmp/cvs-serv19822/src/common

Modified Files:
	util.c 
Log Message:
add documentation for smartlist_join_strings

Index: util.c
===================================================================
RCS file: /home/or/cvsroot/src/common/util.c,v
retrieving revision 1.146
retrieving revision 1.147
diff -u -d -r1.146 -r1.147
--- util.c	14 Oct 2004 19:51:46 -0000	1.146
+++ util.c	15 Oct 2004 03:55:02 -0000	1.147
@@ -609,6 +609,11 @@
   return n;
 }
 
+/** Allocate and return a new string containing the concatenation of
+ * the elements of <b>sl</b>, in order, separated by <b>join</b>.  If
+ * <b>terminate</b> is true, also terminate the string with <b>join</b>.
+ * Requires that every element of <b>sl</b> is NUL-terminated string.
+ */
 char *smartlist_join_strings(smartlist_t *sl, const char *join, int terminate)
 {
   int i;