Improve documentation of smartlist_split_string

This commit is contained in:
Robert Ransom 2011-06-22 13:47:32 -07:00
parent d7254bea11
commit 2b5ebc7097

View File

@ -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>, * 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>&amp;SPLIT_SKIP_SPACE is true, remove initial and * If <b>flags</b>&amp;SPLIT_SKIP_SPACE is true, remove initial and
* trailing space from each entry. * trailing space from each entry.
@ -347,7 +348,7 @@ smartlist_insert(smartlist_t *sl, int idx, void *val)
* If <b>flags</b>&amp;SPLIT_STRIP_SPACE is true, strip spaces from each * If <b>flags</b>&amp;SPLIT_STRIP_SPACE is true, strip spaces from each
* split string. * 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. * <b>sep</b> is NULL, split on any sequence of horizontal space.
*/ */
int int