From 0c7649d030d980755d9659574214f104368fc6a0 Mon Sep 17 00:00:00 2001 From: Michael Drake Date: Sun, 24 Jul 2016 21:08:05 +0100 Subject: [PATCH] URL escape: Improve API documentation. --- utils/url.h | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/utils/url.h b/utils/url.h index c22c43b2a..b80fadd67 100644 --- a/utils/url.h +++ b/utils/url.h @@ -31,10 +31,12 @@ /** * Escape a string suitable for inclusion in an URL. * - * \param unescaped the unescaped string - * \param sptoplus true iff spaces should be converted to + - * \param escexceptions NULL or a string of characters excluded to be escaped - * \param result pointer to pointer to buffer to hold escaped string + * \param[in] unescaped the unescaped string + * \param[in] sptoplus true iff spaces should be converted to + + * \param[in] escexceptions NULL or a string of characters to be excluded + * from escaping. + * \param[out] result Returns pointer to buffer to escaped string. + * Returned string is '\0' terminated. * \return NSERROR_OK on success */ nserror url_escape(const char *unescaped, bool sptoplus,