diff options
author | Michael Drake <tlsa@netsurf-browser.org> | 2016-07-24 21:08:05 +0100 |
---|---|---|
committer | Michael Drake <tlsa@netsurf-browser.org> | 2016-07-25 09:04:35 +0100 |
commit | 0c7649d030d980755d9659574214f104368fc6a0 (patch) | |
tree | e49cf911d91ca76957b48211adfe2bcd0851c8ac | |
parent | a122b94efde125202388d135e36eb86e6d25d093 (diff) | |
download | netsurf-0c7649d030d980755d9659574214f104368fc6a0.tar.gz netsurf-0c7649d030d980755d9659574214f104368fc6a0.tar.bz2 |
URL escape: Improve API documentation.
-rw-r--r-- | utils/url.h | 10 |
1 files 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, |