From 84f739036d47dbd35ce06b049a3de4a35470e31e Mon Sep 17 00:00:00 2001 From: Petri Lehtinen Date: Tue, 4 Oct 2011 21:04:56 +0300 Subject: [PATCH] Documentation fixes --- doc/apiref.rst | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/doc/apiref.rst b/doc/apiref.rst index 59d86fb..7d69004 100644 --- a/doc/apiref.rst +++ b/doc/apiref.rst @@ -703,9 +703,9 @@ can be ORed together to obtain *flags*. ``JSON_INDENT(n)`` Pretty-print the result, using newlines between array and object items, and indenting with *n* spaces. The valid range for *n* is - between 0 and 32, other values result in an undefined output. If - ``JSON_INDENT`` is not used or *n* is 0, no newlines are inserted - between array and object items. + between 0 and 31 (inclusive), other values result in an undefined + output. If ``JSON_INDENT`` is not used or *n* is 0, no newlines are + inserted between array and object items. ``JSON_COMPACT`` This flag enables a compact representation, i.e. sets the separator @@ -859,6 +859,16 @@ The following functions perform the actual JSON decoding. filled with information about the error. *flags* is described above. + This function will start reading the input from whatever position + the input file was, without attempting to seek first. If an error + occurs, the file position will be left indeterminate. On success, + the file position will be at EOF, unless ``JSON_DISABLE_EOF_CHECK`` + flag was used. In this case, the file position will be at the first + character after the last ``]`` or ``}`` in the JSON input. This + allows calling :func:`json_loadf()` on the same ``FILE`` object + multiple times, if the input consists of consecutive JSON texts, + possibly separated by whitespace. + .. function:: json_t *json_load_file(const char *path, size_t flags, json_error_t *error) .. refcounting:: new @@ -1261,5 +1271,5 @@ JSON structures by zeroing all memory when freed:: For more information about the issues of storing sensitive data in memory, see http://www.dwheeler.com/secure-programs/Secure-Programs-HOWTO/protect-secrets.html. -The page also examplains the :func:`guaranteed_memset()` function used +The page also explains the :func:`guaranteed_memset()` function used in the example and gives a sample implementation for it. -- 2.1.4