Danielsh suggested on IRC that I clarify the API documentation for the
function svn_cstring_split().
[[[
Clarify the doxygen documentation for the semantics of the @a sep_chars
parameter.
* subversion/include/svn_string.h
(svn_cstring_split): Update doxygen comment.
Suggested by: Danielsh
]]]
Index: subversion/include/svn_string.h
===================================================================
--- subversion/include/svn_string.h (revision 1471133)
+++ subversion/include/svn_string.h (working copy)
@@ -407,15 +407,17 @@ svn_string_compare_stringbuf(const svn_string_t *s
* @{
*/
-/** Divide @a input into substrings along @a sep_chars boundaries, return an
- * array of copies of those substrings (plain const char*), allocating both
- * the array and the copies in @a pool.
+/** Divide @a input into substrings, interpreting any char from @a sep
+ * as a token separator.
*
- * None of the elements added to the array contain any of the
- * characters in @a sep_chars, and none of the new elements are empty
- * (thus, it is possible that the returned array will have length
- * zero).
+ * Return an array of copies of those substrings (plain const char*),
+ * allocating both the array and the copies in @a pool.
*
+ * Because none of the elements added to the resulting array contain
+ * any of the characters in @a sep_chars, and none of the new elements
+ * are empty, it is possible that the returned array will have length
+ * zero.
+ *
* If @a chop_whitespace is TRUE, then remove leading and trailing
* whitespace from the returned strings.
*/
