Skip to content

Commit c4a1a8a

Browse files
committed
Doc
1 parent d39587a commit c4a1a8a

35 files changed

+72
-72
lines changed

doc/ref/bson/basic_bson_cursor.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
#include <jsoncons_ext/bson/bson_cursor.hpp>
55

66
template<
7-
class Source=jsoncons::binary_stream_source,
8-
class Allocator=std::allocator<char>>
7+
typename Source=jsoncons::binary_stream_source,
8+
typename Allocator=std::allocator<char>>
99
class basic_bson_cursor;
1010
```
1111

doc/ref/bson/basic_bson_encoder.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#include <jsoncons_ext/bson/bson_encoder.hpp>
55

66
template<
7-
class Sink>
7+
typename Sink>
88
> class basic_bson_encoder : public jsoncons::json_visitor
99
```
1010

doc/ref/bson/decode_bson.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ template <typename T,typename InputIt>
2121
T decode_bson(InputIt first, InputIt last,
2222
const bson_decode_options& options = bson_decode_options()); (3) (since 0.153.0)
2323

24-
template <typename T,typename Source,class Allocator,class TempAllocator>
24+
template <typename T,typename Source,typename Allocator,typename TempAllocator>
2525
T decode_bson(const allocator_set<Allocator,TempAllocator>& alloc_set,
2626
const Source& source,
2727
const bson_decode_options& options = bson_decode_options()); (4) (since 0.171.0)
2828

29-
template <typename T,class Allocator,class TempAllocator>
29+
template <typename T,typename Allocator,typename TempAllocator>
3030
T decode_bson(const allocator_set<Allocator,TempAllocator>& alloc_set,
3131
std::istream& is,
3232
const bson_decode_options& options = bson_decode_options()); (5) (since 0.171.0)

doc/ref/cbor/basic_cbor_cursor.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
#include <jsoncons_ext/cbor/cbor_cursor.hpp>
55

66
template<
7-
class Source=jsoncons::binary_stream_source,
8-
class Allocator=std::allocator<char>>
7+
typename Source=jsoncons::binary_stream_source,
8+
typename Allocator=std::allocator<char>>
99
class basic_cbor_cursor;
1010
```
1111

doc/ref/cbor/basic_cbor_encoder.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#include <jsoncons_ext/cbor/cbor_encoder.hpp>
55

66
template<
7-
class Sink>
7+
typename Sink>
88
> class basic_cbor_encoder final : public json_visitor
99
```
1010

doc/ref/cbor/decode_cbor.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ template <typename T,typename InputIt>
2525
T decode_cbor(InputIt first, InputIt last,
2626
const cbor_decode_options& options = cbor_decode_options()); (3) (since 0.153.0)
2727

28-
template <typename T,typename Source,class Allocator,class TempAllocator>
28+
template <typename T,typename Source,typename Allocator,typename TempAllocator>
2929
T decode_cbor(const allocator_set<Allocator,TempAllocator>& alloc_set,
3030
const Source& source,
3131
const cbor_decode_options& options = cbor_decode_options()); (4) (since 0.171.0)
3232

33-
template <typename T,class Allocator,class TempAllocator>
33+
template <typename T,typename Allocator,typename TempAllocator>
3434
T decode_cbor(const allocator_set<Allocator,TempAllocator>& alloc_set,
3535
std::istream& is,
3636
const cbor_decode_options& options = cbor_decode_options()); (5) (since 0.171.0)

doc/ref/corelib/allocator_set.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#include <jsoncons/allocator_set.hpp>
55

66
template<
7-
class Allocator,class TempAllocator
7+
typename Allocator,typename TempAllocator
88
> allocator_set;
99
```
1010

@@ -36,7 +36,7 @@ Returns an allocator object for for temporary allocations
3636

3737
#### Helper functions
3838

39-
template <typename Allocator,class TempAllocator>
39+
template <typename Allocator,typename TempAllocator>
4040
allocator_set<Allocator,TempAllocator> combine_allocators(
4141
const Allocator& alloc, const TempAllocator& temp_alloc);
4242

doc/ref/corelib/basic_default_json_visitor.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#include <jsoncons/json_visitor.hpp>
55

66
template <
7-
class CharT
7+
typename CharT
88
> class basic_default_json_visitor
99
```
1010

doc/ref/corelib/basic_json.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
#include <jsoncons/basic_json.hpp>
55

66
template<
7-
class CharT,
7+
typename CharT,
88
class Policy = sorted_policy,
9-
class Allocator = std::allocator<char>
9+
typename Allocator = std::allocator<char>
1010
> class basic_json;
1111

1212
namespace pmr {

doc/ref/corelib/basic_json_cursor.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
#include <jsoncons/json_cursor.hpp>
55

66
template<
7-
class CharT,
8-
class Source=jsoncons::stream_source<CharT>,
9-
class Allocator=std::allocator<char>> basic_json_cursor;
7+
typename CharT,
8+
typename Source=jsoncons::stream_source<CharT>,
9+
typename Allocator=std::allocator<char>> basic_json_cursor;
1010
```
1111

1212
A pull parser for reporting JSON parse events. A typical application will

doc/ref/corelib/basic_json_encoder.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
#include <jsoncons/json_encoder.hpp>
55

66
template<
7-
class CharT,
8-
class Sink>
7+
typename CharT,
8+
typename Sink>
99
> basic_json_encoder : public jsoncons::basic_json_visitor<CharT>
1010

1111
template<
12-
class CharT,
13-
class Sink>
12+
typename CharT,
13+
typename Sink>
1414
> basic_compact_json_encoder : public jsoncons::basic_json_visitor<CharT>
1515
```
1616

doc/ref/corelib/basic_json_filter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#include <jsoncons/json_filter.hpp>
55

66
template <
7-
class CharT
7+
typename CharT
88
> class basic_json_filter
99
```
1010

doc/ref/corelib/basic_json_options.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#include <jsoncons/json_options.hpp>
55

66
template<
7-
class CharT
7+
typename CharT
88
> class basic_json_options;
99
```
1010

doc/ref/corelib/basic_json_reader.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
#include <jsoncons/json_reader.hpp>
55

66
template<
7-
class CharT,
8-
class Source=jsoncons::stream_source<CharT>,
9-
class TempAllocator=std::allocator<char>
7+
typename CharT,
8+
typename Source=jsoncons::stream_source<CharT>,
9+
typename TempAllocator=std::allocator<char>
1010
>
1111
class basic_json_reader
1212
```

doc/ref/corelib/basic_json_visitor.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#include <jsoncons/json_visitor.hpp>
55

66
template <
7-
class CharT
7+
typename CharT
88
> class basic_json_visitor
99
```
1010

doc/ref/corelib/json/get_value_or.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
### jsoncons::basic_json::get_value_or
22

33
```cpp
4-
template <typename T,class U>
4+
template <typename T,typename U>
55
T get_value_or(const string_view_type& name, U&& default_value) const;
66
```
77

doc/ref/corelib/json/parse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ static basic_json parse(const allocator_set<allocator_type,TempAllocator>& alloc
3838
std::basic_istream<char_type>& is,
3939
const basic_json_decode_options<char_type>& options = basic_json_decode_options<CharT>()); (9) (since 0.171.0)
4040

41-
template <typename InputIt,class TempAllocator>
41+
template <typename InputIt,typename TempAllocator>
4242
static basic_json parse(const allocator_set<allocator_type,TempAllocator>& alloc_set,
4343
InputIt first, InputIt last,
4444
const basic_json_decode_options<char_type>& options = basic_json_decode_options<CharT>()); (10) (since 0.171.0)

doc/ref/corelib/json_decoder.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
```cpp
44
#include <jsoncons/json_decoder.hpp>
55

6-
template <typename Json,class TempAllocator>
6+
template <typename Json,typename TempAllocator>
77
json_decoder
88
```
99

doc/ref/corelib/staj_array_iterator.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
#include <jsoncons/staj_iterator.hpp>
55

66
template<
7-
class T,
8-
class Json
7+
typename T,
8+
typename Json
99
>
1010
class staj_array_iterator
1111
```
@@ -61,7 +61,7 @@ Advances the iterator to the next array element.
6161
6262
#### Non-member functions
6363
64-
template <typename class T,typename Json>
64+
template <typename T,typename Json>
6565
bool operator==(const staj_array_iterator<T, Json>& a, const staj_array_iterator<T, Json>& b);
6666
6767
template <typename Json,typename T>

doc/ref/corelib/staj_object_iterator.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
#include <jsoncons/staj_iterator.hpp>
55

66
template<
7-
class Key,
8-
class T,
9-
class Json
7+
typename Key,
8+
typename T,
9+
typename Json
1010
> class staj_object_iterator
1111
```
1212

doc/ref/csv/basic_csv_cursor.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
#include <jsoncons_ext/csv/csv_cursor.hpp>
55

66
template<
7-
class CharT,
8-
class Source=jsoncons::stream_source<CharT>,
9-
class Allocator=std::allocator<char>> basic_csv_cursor;
7+
typename CharT,
8+
typename Source=jsoncons::stream_source<CharT>,
9+
typename Allocator=std::allocator<char>> basic_csv_cursor;
1010
```
1111

1212
A pull parser for reporting CSV parse events. A typical application will

doc/ref/csv/basic_csv_encoder.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
#include <jsoncons_ext/csv/csv_encoder.hpp>
55

66
template<
7-
class CharT,
8-
class Sink,
9-
class Allocator=std::allocator<CharT>=std::allocator<CharT>>
7+
typename CharT,
8+
typename Sink,
9+
typename Allocator=std::allocator<CharT>=std::allocator<CharT>>
1010
> class basic_csv_encoder : public jsoncons::basic_json_visitor<CharT>
1111
```
1212

doc/ref/csv/basic_csv_options.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#include <jsoncons_ext/csv/csv_options.hpp>
55

66
template<
7-
class CharT
7+
typename CharT
88
> class basic_csv_options;
99
```
1010

doc/ref/csv/basic_csv_reader.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
#include <jsoncons_ext/csv/csv_reader.hpp>
55

66
template<
7-
class CharT,
8-
class Source=jsoncons::stream_source<CharT>,
9-
class TempAllocator=std::allocator<char>>
7+
typename CharT,
8+
typename Source=jsoncons::stream_source<CharT>,
9+
typename TempAllocator=std::allocator<char>>
1010
class basic_csv_reader
1111
```
1212

doc/ref/csv/decode_csv.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ Decodes a [comma-separated variables (CSV)](https://en.wikipedia.org/wiki/Comma-
55
```cpp
66
#include <jsoncons_ext/csv/csv.hpp>
77

8-
template <typename T,class Source>
8+
template <typename T,typename Source>
99
T decode_csv(const Source& s,
1010
const basic_csv_decode_options<CharT>& options = basic_csv_decode_options<CharT>())); (1)
1111

12-
template <typename T,class CharT>
12+
template <typename T,typename CharT>
1313
T decode_csv(std::basic_istream<CharT>& is,
1414
const basic_csv_decode_options<CharT>& options = basic_csv_decode_options<CharT>())); (2)
1515

16-
template <typename T,class InputIt>
16+
template <typename T,typename InputIt>
1717
T decode_csv(InputIt first, InputIt last,
1818
const basic_csv_decode_options<CharT>& options = basic_csv_decode_options<CharT>())); (3) (since 0.153.0)
1919

doc/ref/csv/encode_csv.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Encodes a C++ data structure into the CSV data format.
55
```cpp
66
#include <jsoncons_ext/csv/csv.hpp>
77

8-
template <typename T,class CharContainer>
8+
template <typename T,typename CharContainer>
99
void encode_csv(const T& val, CharContainer& cont,
1010
const basic_csv_encode_options<CharContainer::value_type>& options
1111
= basic_csv_encode_options<CharContainer::value_type>()); (1)
@@ -15,7 +15,7 @@ void encode_csv(const T& val, std::basic_ostream<CharT>& os,
1515
const basic_csv_encode_options<CharT>& options
1616
= basic_csv_encode_options<CharT>()); (2)
1717

18-
template <typename T,class CharContainer>
18+
template <typename T,typename CharContainer>
1919
void encode_csv(const allocator_set<Allocator,TempAllocator>& alloc_set,
2020
const T& val, CharContainer& cont,
2121
const basic_csv_encode_options<CharContainer::value_type>& options

doc/ref/jsonpointer/basic_json_pointer.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -98,19 +98,19 @@ URI fragment identifier (starts with `#`).
9898
basic_json_pointer<CharT> operator/(const basic_json_pointer<CharT>& lhs, const basic_string<CharT>& s);
9999
Concatenates a JSON Pointer pointer and a string. Effectively returns basic_json_pointer<CharT>(lhs) /= s.
100100
101-
template <typename CharT,class IntegerType>
101+
template <typename CharT,typename IntegerType>
102102
basic_json_pointer<CharT> operator/(const basic_json_pointer<CharT>& lhs, IntegerType index);
103103
Concatenates a JSON Pointer pointer and an index. Effectively returns basic_json_pointer<CharT>(lhs) /= index.
104104
This overload only participates in overload resolution if `IntegerType` is an integer type.
105105
106-
template <typename CharT,class IntegerType>
106+
template <typename CharT,typename IntegerType>
107107
basic_json_pointer<CharT> operator+( const basic_json_pointer<CharT>& lhs, const basic_json_pointer<CharT>& rhs );
108108
Concatenates two JSON Pointers. Effectively returns basic_json_pointer<CharT>(lhs) += rhs.
109109
110-
template <typename CharT,class IntegerType>
110+
template <typename CharT,typename IntegerType>
111111
bool operator==(const basic_json_pointer<CharT>& lhs, const basic_json_pointer<CharT>& rhs);
112112
113-
template <typename CharT,class IntegerType>
113+
template <typename CharT,typename IntegerType>
114114
bool operator!=(const basic_json_pointer<CharT>& lhs, const basic_json_pointer<CharT>& rhs);
115115
116116
std::string to_string(const json_pointer& ptr); (since 0.172.0)

doc/ref/jsonschema/make_json_schema.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ template <typename Json>
1111
json_schema<Json> make_json_schema(Json sch, (since 0.175.0)
1212
evaluation_options options = evaluation_options{});
1313

14-
template <typename Json,class SchemaResolver>
14+
template <typename Json,typename SchemaResolver>
1515
json_schema<Json> make_json_schema(const Json& sch, (until 0.175.0)
1616
const SchemaResolver& resolver,
1717
evaluation_options options = evaluation_options{}); (2)
1818

19-
template <typename Json,class SchemaResolver>
19+
template <typename Json,typename SchemaResolver>
2020
json_schema<Json> make_json_schema(Json sch, (since 0.175.0)
2121
const SchemaResolver& resolver,
2222
evaluation_options options = evaluation_options{});
@@ -31,13 +31,13 @@ json_schema<Json> make_json_schema(Json sch, (since 0.175
3131
const std::string& retrieval_uri,
3232
evaluation_options options = evaluation_options{});
3333

34-
template <typename Json,class SchemaResolver>
34+
template <typename Json,typename SchemaResolver>
3535
json_schema<Json> make_json_schema(const Json& sch, (until 0.175.0)
3636
const std::string& retrieval_uri,
3737
const SchemaResolver& resolver,
3838
evaluation_options options = evaluation_options{});
3939
(4)
40-
template <typename Json,class SchemaResolver>
40+
template <typename Json,typename SchemaResolver>
4141
json_schema<Json> make_json_schema(Json sch, (since 0.175.0)
4242
const std::string& retrieval_uri,
4343
const SchemaResolver& resolver,

doc/ref/jsonschema/make_schema.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ template <typename Json>
1212
std::shared_ptr<json_schema<Json>> make_schema(const Json& schema,
1313
const std::string& retrieval_uri); (2) (since 0.173.0)
1414

15-
template <typename Json,class SchemaResolver>
15+
template <typename Json,typename SchemaResolver>
1616
std::shared_ptr<json_schema<Json>> make_schema(const Json& schema,
1717
const std::string& retrieval_uri, const SchemaResolver& resolver); (3) (since 0.173.0)
1818

19-
template <typename Json,class SchemaResolver>
19+
template <typename Json,typename SchemaResolver>
2020
std::shared_ptr<json_schema<Json>> make_schema(const Json& schema,
2121
const SchemaResolver& resolver); (4)
2222
```

0 commit comments

Comments
 (0)