🔥 consolidate documentation
This commit is contained in:
parent
54b05a2672
commit
c353461f83
@ -3,3 +3,10 @@
|
||||
```cpp
|
||||
using json = basic_json<>;
|
||||
```
|
||||
|
||||
This type is the default specialization of the [basic_json](basic_json/index.md) class which uses the standard template
|
||||
types.
|
||||
|
||||
## Version history
|
||||
|
||||
Since version 1.0.0.
|
||||
|
||||
@ -3,3 +3,13 @@
|
||||
```cpp
|
||||
using ordered_json = basic_json<nlohmann::ordered_map>;
|
||||
```
|
||||
|
||||
This type preserves the insertion order of object keys.
|
||||
|
||||
## See also
|
||||
|
||||
- [ordered_map](ordered_map.md)
|
||||
|
||||
## Version history
|
||||
|
||||
Since version 3.9.0.
|
||||
|
||||
@ -66,3 +66,8 @@ To implement your own SAX handler, proceed as follows:
|
||||
3. Call `#!cpp bool json::sax_parse(input, &my_sax);` where the first parameter can be any input like a string or an input stream and the second parameter is a pointer to your SAX interface.
|
||||
|
||||
Note the `sax_parse` function only returns a `#!cpp bool` indicating the result of the last executed SAX event. It does not return `json` value - it is up to you to decide what to do with the SAX events. Furthermore, no exceptions are thrown in case of a parse error - it is up to you what to do with the exception object passed to your `parse_error` implementation. Internally, the SAX interface is used for the DOM parser (class `json_sax_dom_parser`) as well as the acceptor (`json_sax_acceptor`), see file `json_sax.hpp`.
|
||||
|
||||
## See also
|
||||
|
||||
- [json_say](../../api/json_sax/index.md) - documentation of the SAX interface
|
||||
- [sax_parse](../../api/basic_json/sax_parse.md) - SAX parser
|
||||
|
||||
Loading…
Reference in New Issue
Block a user