jansson/doc
Nathaniel McCallum b8bb078cc2 Add JSON_EMBED encoding flag
The JSON_EMBED encoding flag causes the opening and closing characters
of the top-level array ('[', ']') or object ('{', '}') to be omitted
during encoding. This feature makes it possible to concatenate multiple
arrays or objects in the stream output. It also makes it possible to
perform outputs of partial composes.

One such example of a partial compose is when outputting a JWE object.
The output is a JSON object. But it has one top-level attribute
("ciphertext") that can grow out of proportion with the rest of the
metadata. With the JSON_EMBED flag, the other metadata can be composed
ahead of time and dumped during the beginning of output, where the
"ciphertext" and "tag" attributes can be streamed out in chunks. Thus,
the header material can be composed with Jansson and the ciphertext
itself can be composed manually.
2017-02-27 15:09:03 -05:00
..
ext Update copyrights for 2016 2016-09-18 14:17:03 +03:00
.gitignore Remove CHANGES preprocessing, as it didn't work with VPATH builds 2010-01-21 20:53:05 +02:00
apiref.rst Add JSON_EMBED encoding flag 2017-02-27 15:09:03 -05:00
changes.rst Remove CHANGES preprocessing, as it didn't work with VPATH builds 2010-01-21 20:53:05 +02:00
conf.py doc: Change version to 2.10-dev 2016-09-18 14:52:26 +03:00
conformance.rst Fix for issue #282 2016-05-03 10:22:06 +02:00
gettingstarted.rst jansson 2.8 2016-08-30 21:09:28 +03:00
github_commits.c Update copyrights for 2016 2016-09-18 14:17:03 +03:00
index.rst doc: Add project status to introduction, add portability chapter 2011-10-03 22:42:39 +03:00
Makefile.am Distribute doc/portability.rst 2011-10-06 21:23:09 +03:00
portability.rst Document json_object_seed() 2014-02-11 09:38:45 +02:00
README Build documentation in make html target 2009-11-03 23:09:04 +02:00
tutorial.rst jansson 2.8 2016-08-30 21:09:28 +03:00
upgrading.rst doc: Change the title of the upgrading section 2011-02-25 21:01:13 +02:00

To build the documentation, invoke

    make html

Then point your browser to _build/html/index.html.