Skip to content

Commit 95a220d

Browse files
committed
Doc update
1 parent 70a26f8 commit 95a220d

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

CHANGELOG.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
`null`, `boolean`, `int64`, `uint64`, `float16`, `float64`, `string`,
5454
`byte_string`, `array` and `object` respectively. It's unlikely that we have
5555
many users of `json_type`, it isn't used in any of our examples, but for
56-
backwards compatability the old names, now deprecated, have been typedefed to
56+
backwards compatibility the old names, now deprecated, have been typedef-ed to
5757
the new names.
5858

5959
- The `json_options` member name `line_splits` has been renamed to `root_line_spits`.
@@ -1104,7 +1104,7 @@ the same node paths) to be excluded from results, and for results to be sorted i
11041104
Changes to `json_query`
11051105
11061106
- The parameter `result_type` has been replaced by a bitmask type `result_options`.
1107-
For backwards compatability, `result_type` has been typedefed to `result_options`,
1107+
For backwards compatability, `result_type` has been typedef-ed to `result_options`,
11081108
and the `value` and `path` enumerators are still there. In addition, `result_options`
11091109
provides options for excluding duplicates from results, and for results to be sorted in
11101110
path order.
@@ -1252,7 +1252,7 @@ Change reverted:
12521252
12531253
- The name change `ser_error` to `codec_error` introduced in
12541254
0.157.0 has been reverted back to `ser_error`. Just in case
1255-
anybody used it, the name `codec_error` has been typedefed
1255+
anybody used it, the name `codec_error` has been typedef-ed
12561256
to `ser_error`.
12571257
12581258
0.157.0
@@ -3834,7 +3834,7 @@ Changes to extensions:
38343834

38353835
- Reversion of 0.96 change:
38363836

3837-
The virtual methods `do_float_value`, `do_integer_value`, and `do_unsigned_value` of `json_input_handler` and `json_output_handler` have been restored to `do_double_value`, `do_longlong_value` and `do_ulonglong_value`, and their typedefed parameter types `float_type`, `integer_type`, and `unsigned_type` have been restored to `double`, `long long`, and `unsigned long long`.
3837+
The virtual methods `do_float_value`, `do_integer_value`, and `do_unsigned_value` of `json_input_handler` and `json_output_handler` have been restored to `do_double_value`, `do_longlong_value` and `do_ulonglong_value`, and their typedef-ed parameter types `float_type`, `integer_type`, and `unsigned_type` have been restored to `double`, `long long`, and `unsigned long long`.
38383838

38393839
The rationale for this reversion is that the change doesn't really help to make the software more flexible, and that it's better to leave out the typedefs. There will be future enhancements to support greater numeric precision, but these will not affect the current method signatures.
38403840

@@ -3999,7 +3999,7 @@ New extensions
39993999
New features
40004000

40014001
- Supports wide character strings and streams with wjson, wjson_reader etc. Assumes UTF16 encoding if sizeof(wchar_t)=2 and UTF32 encoding if sizeof(wchar_t)=4.
4002-
- The empty class null_type is added to the jsoncons namespace, it replaces the member type json::null_type (json::null_type is typedefed to jsoncons::null_type for backward compatibility.)
4002+
- The empty class null_type is added to the jsoncons namespace, it replaces the member type json::null_type (json::null_type is typedef-ed to jsoncons::null_type for backward compatibility.)
40034003

40044004
Defect fixes:
40054005

@@ -4020,7 +4020,7 @@ Breaking change (but only if you have subclassed json_input_handler or json_outp
40204020

40214021
Non breaking changes (previous features are deprecated but still work)
40224022

4023-
- name_value_pair has been renamed to member_type (typedefed to previous name.)
4023+
- name_value_pair has been renamed to member_type (typedef-ed to previous name.)
40244024

40254025
- as_string(output_format format) has been deprecated, use the existing to_string(output_format format) instead
40264026

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@ Or, download the latest code on [main](https://github.com/danielaparker/jsoncons
101101
- [Ask questions and suggest ideas for new features](https://github.com/danielaparker/jsoncons/discussions)
102102

103103
The library requires a C++ Compiler with C++11 support. In addition the library defines `jsoncons::endian`,
104-
`jsoncons::basic_string_view`, `jsoncons::optional`, and `jsoncons::span`, which will be typedefed to
105-
their standard library equivalents if detected. Otherwise they will be typedefed to internal, C++11 compatible, implementations.
104+
`jsoncons::basic_string_view`, `jsoncons::optional`, and `jsoncons::span`, which will be typedef-ed to
105+
their standard library equivalents if detected. Otherwise they will be typedef-ed to internal, C++11 compatible, implementations.
106106

107107
The library uses exceptions and in some cases [std::error_code](https://en.cppreference.com/w/cpp/error/error_code)'s to report errors. Apart from `jsoncons::assertion_error`,
108108
all jsoncons exception classes implement the [jsoncons::json_error](doc/ref/corelib/json_error.md) interface.

doc/ref/corelib/basic_default_json_visitor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ wdefault_json_visitor |`basic_default_json_visitor<wchar_t>`
2525
Member type |Definition
2626
------------------------------------|------------------------------
2727
`char_type`|CharT
28-
`string_view_type`|A non-owning view of a string, holds a pointer to character data and length. Supports conversion to and from strings. Will be typedefed to the C++ 17 [std::string view](http://en.cppreference.com/w/cpp/string/basic_string_view) if C++ 17 is detected or if `JSONCONS_HAS_STD_STRING_VIEW` is defined, otherwise proxied.
28+
`string_view_type`|A non-owning view of a string, holds a pointer to character data and length. Supports conversion to and from strings. Will be typedef-ed to the C++ 17 [std::string view](http://en.cppreference.com/w/cpp/string/basic_string_view) if C++ 17 is detected or if `JSONCONS_HAS_STD_STRING_VIEW` is defined, otherwise proxied.
2929
3030
#### Constructors
3131

doc/ref/corelib/basic_json_filter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ wjson_filter |`basic_json_filter<wchar_t>`
2626
Member type |Definition
2727
------------------------------------|------------------------------
2828
`char_type`|CharT
29-
`string_view_type`|A non-owning view of a string, holds a pointer to character data and length. Supports conversion to and from strings. Will be typedefed to the C++ 17 [std::string view](http://en.cppreference.com/w/cpp/string/basic_string_view) if C++ 17 is detected or if `JSONCONS_HAS_STD_STRING_VIEW` is defined, otherwise proxied.
29+
`string_view_type`|A non-owning view of a string, holds a pointer to character data and length. Supports conversion to and from strings. Will be typedef-ed to the C++ 17 [std::string view](http://en.cppreference.com/w/cpp/string/basic_string_view) if C++ 17 is detected or if `JSONCONS_HAS_STD_STRING_VIEW` is defined, otherwise proxied.
3030
3131
#### Constructors
3232

doc/ref/corelib/basic_json_visitor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ wjson_visitor |`basic_json_visitor<wchar_t>`
2222
Member type |Definition
2323
------------------------------------|------------------------------
2424
`char_type`|CharT
25-
`string_view_type`|A non-owning view of a string, holds a pointer to character data and length. Supports conversion to and from strings. Will be typedefed to the C++ 17 [std::string view](http://en.cppreference.com/w/cpp/string/basic_string_view) if C++ 17 is detected or if `JSONCONS_HAS_STD_STRING_VIEW` is defined, otherwise proxied.
25+
`string_view_type`|A non-owning view of a string, holds a pointer to character data and length. Supports conversion to and from strings. Will be typedef-ed to the C++ 17 [std::string view](http://en.cppreference.com/w/cpp/string/basic_string_view) if C++ 17 is detected or if `JSONCONS_HAS_STD_STRING_VIEW` is defined, otherwise proxied.
2626
2727
#### Public event producer interface
2828

doc/ref/jsonpath/json_query.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ void fun(const Json::string_view_type& path, const Json& val);
7575
</tr>
7676
<tr>
7777
<td><code>type</code> (until 0.161.0))</td>
78-
<td>Since 0.161.0, typedefed to <code>jsonpath_options</code>.</td>
78+
<td>Since 0.161.0, typedef-ed to <code>jsonpath_options</code>.</td>
7979
</tr>
8080
<tr>
8181
<td><code>options</code> (since 0.161.0)</td>

0 commit comments

Comments
 (0)