From 780adf95bc4c7cfbb0c4e99cc56ec1282a4818a1 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sun, 24 Jul 2016 11:32:43 +0200 Subject: [PATCH] string.c: Improve documentation of create_argv(). Mention that it is OK to pass NULL, and that the returned array is NULL terminated. --- string.c | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/string.c b/string.c index 86e77538..6033a008 100644 --- a/string.c +++ b/string.c @@ -803,15 +803,18 @@ err: * Split a buffer into words. * * This parser honors single and double quotes, backslash-escaped characters - * and special characters like \p \\n. The result contains pointers to copies - * of the words contained in \a buf and has to be freed by using \ref - * free_argv(). + * and special characters like \\n. The result contains pointers to copies of + * the words contained in buf and has to be freed by using \ref free_argv(). * * \param buf The buffer to be split. * \param delim Each character in this string is treated as a separator. * \param result The array of words is returned here. * - * \return Number of words in \a buf, negative on errors. + * It's OK to pass NULL as the buffer argument. This is equivalent to passing + * the empty string. + * + * \return Number of words in buf, negative on errors. The array returned + * through the result pointer is NULL terminated. */ int create_argv(const char *buf, const char *delim, char ***result) { -- 2.39.2