aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAllen <38368409+AllenX2018@users.noreply.github.com>2019-09-18 16:18:51 +0800
committerGitHub <noreply@github.com>2019-09-18 16:18:51 +0800
commit672b6df4743dbf76e059c640ad3fe45f7c795594 (patch)
treed2fedf987a91a6dfac2e837f3a9c114a1df557fe /doc
parent53e9dd848f924021ec60ab3cd21c0c87c9dce37c (diff)
downloadjansson-672b6df4743dbf76e059c640ad3fe45f7c795594.zip
jansson-672b6df4743dbf76e059c640ad3fe45f7c795594.tar.gz
jansson-672b6df4743dbf76e059c640ad3fe45f7c795594.tar.bz2
Update apiref.rst
fix the documentation about json_dumps. refs #471
Diffstat (limited to 'doc')
-rw-r--r--doc/apiref.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/apiref.rst b/doc/apiref.rst
index 1b305f5..3c4fa47 100644
--- a/doc/apiref.rst
+++ b/doc/apiref.rst
@@ -1091,7 +1091,9 @@ These functions output UTF-8:
Returns the JSON representation of *json* as a string, or *NULL* on
error. *flags* is described above. The return value must be freed
- by the caller using :func:`free()`.
+ by the caller using :func:`free()`. Note that if you have called
+ :func:`json_set_alloc_funcs()` to override :func:`free()`, you should
+ call your custom free function instead to free the return value.
.. function:: size_t json_dumpb(const json_t *json, char *buffer, size_t size, size_t flags)