xref: /aosp_15_r20/external/pigweed/pw_json/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _module-pw_json:
2
3=======
4pw_json
5=======
6.. pigweed-module::
7   :name: pw_json
8
9   Use :cpp:class:`pw::JsonBuilder` to serialize JSON to a buffer. It's simple,
10   safe, and efficient.
11
12   .. literalinclude:: builder_test.cc
13      :language: cpp
14      :start-after: [pw-json-builder-example-1]
15      :end-before: [pw-json-builder-example-1]
16
17   The above code produces JSON equivalent to the following:
18
19   .. code-block:: json
20
21      {
22        "tagline": "Easy, efficient JSON serialization!",
23        "simple": true,
24        "safe": 100,
25        "dynamic allocation": false,
26        "features": ["values", "arrays", "objects", "nesting!"]
27      }
28
29-----------
30JsonBuilder
31-----------
32.. doxygenfile:: pw_json/builder.h
33   :sections: detaileddescription
34
35**Example**
36
37.. literalinclude:: builder_test.cc
38   :language: cpp
39   :start-after: [pw-json-builder-example-2]
40   :end-before: [pw-json-builder-example-2]
41
42API Reference
43=============
44.. doxygengroup:: pw_json_builder_api
45   :content-only:
46   :members:
47