diff options
| author | Robert Ransom <rransom.8774@gmail.com> | 2011-06-22 13:47:32 -0700 |
|---|---|---|
| committer | Robert Ransom <rransom.8774@gmail.com> | 2011-06-22 14:09:43 -0700 |
| commit | 2b5ebc70973b1c0dd62201908632733c0953a4ec (patch) | |
| tree | 95bd8dfc43b9e704f9b34e0d6f84c5e00cc392d6 | |
| parent | d7254bea11a0fc2685cc2ea24fb57d2ab3945b2f (diff) | |
| download | tor-2b5ebc70973b1c0dd62201908632733c0953a4ec.tar.gz tor-2b5ebc70973b1c0dd62201908632733c0953a4ec.zip | |
Improve documentation of smartlist_split_string
| -rw-r--r-- | src/common/container.c | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/common/container.c b/src/common/container.c index da44b7fe68..1515c387ad 100644 --- a/src/common/container.c +++ b/src/common/container.c @@ -338,7 +338,8 @@ smartlist_insert(smartlist_t *sl, int idx, void *val) /** * Split a string <b>str</b> along all occurrences of <b>sep</b>, - * adding the split strings, in order, to <b>sl</b>. + * appending the (newly allocated) split strings, in order, to + * <b>sl</b>. Return the number of strings added to <b>sl</b>. * * If <b>flags</b>&SPLIT_SKIP_SPACE is true, remove initial and * trailing space from each entry. @@ -347,7 +348,7 @@ smartlist_insert(smartlist_t *sl, int idx, void *val) * If <b>flags</b>&SPLIT_STRIP_SPACE is true, strip spaces from each * split string. * - * If max>0, divide the string into no more than <b>max</b> pieces. If + * If <b>max</b>\>0, divide the string into no more than <b>max</b> pieces. If * <b>sep</b> is NULL, split on any sequence of horizontal space. */ int |