External/json
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update json_pointer docs

Browse Source
This commit is contained in:
Florian Albrechtskirchinger 2022-04-05 06:39:54 +02:00
parent 38f251f158
commit 03dbf3ed97
10 changed files with 49 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/mkdocs/docs/api/json_pointer/back.md
View File

@ -1,7 +1,7 @@
# <small>nlohmann::json_pointer::</small>back # <small>nlohmann::json_pointer::</small>back
```cpp ```cpp
const std::string& back() const; const string_t& back() const;
``` ```
Return last reference token. Return last reference token.
@ -36,4 +36,5 @@ Constant.
## Version history ## Version history
Added in version 3.6.0. - Added in version 3.6.0.
- Changed return type to `string_t` in version 3.10.6.

19
doc/mkdocs/docs/api/json_pointer/index.md
View File

@ -1,7 +1,7 @@
# <small>nlohmann::</small>json_pointer # <small>nlohmann::</small>json_pointer
```cpp ```cpp
template<typename BasicJsonType> template<typename RefStringType>
class json_pointer; class json_pointer;
``` ```
@ -11,14 +11,18 @@ are the base for JSON patches.
## Template parameters ## Template parameters
`BasicJsonType` `RefStringType`
: a specialization of [`basic_json`](../basic_json/index.md) : the string type used for the reference tokens making up the JSON pointer
## Notes
For backwards compatibility `RefStringType` may also be a specialization of [`basic_json`](../basic_json/index.md) in which case `string_t` will be deduced as [`basic_json::string_t`](../basic_json/string_t.md). This feature is deprecated and may be removed in a future major version.
## Member functions ## Member functions
- [(constructor)](json_pointer.md) - [(constructor)](json_pointer.md)
- [**to_string**](to_string.md) - return a string representation of the JSON pointer - [**to_string**](to_string.md) - return a string representation of the JSON pointer
- [**operator std::string**](operator_string.md) - return a string representation of the JSON pointer - [**operator string_t**](operator_string.md) - return a string representation of the JSON pointer
- [**operator/=**](operator_slasheq.md) - append to the end of the JSON pointer - [**operator/=**](operator_slasheq.md) - append to the end of the JSON pointer
- [**operator/**](operator_slash.md) - create JSON Pointer by appending - [**operator/**](operator_slash.md) - create JSON Pointer by appending
- [**parent_pointer**](parent_pointer.md) - returns the parent of this JSON pointer - [**parent_pointer**](parent_pointer.md) - returns the parent of this JSON pointer
@ -27,6 +31,10 @@ are the base for JSON patches.
- [**push_back**](push_back.md) - append an unescaped token at the end of the pointer - [**push_back**](push_back.md) - append an unescaped token at the end of the pointer
- [**empty**](empty.md) - return whether pointer points to the root document - [**empty**](empty.md) - return whether pointer points to the root document
## Member types
- [**string_t**](string_t.md) - the string type used for the reference tokens
## See also ## See also
- [operator""_json_pointer](../basic_json/operator_literal_json_pointer.md) - user-defined string literal for JSON pointers - [operator""_json_pointer](../basic_json/operator_literal_json_pointer.md) - user-defined string literal for JSON pointers
@ -34,4 +42,5 @@ are the base for JSON patches.
## Version history ## Version history
Added in version 2.0.0. - Added in version 2.0.0.
- Changed template parameter from `basic_json` to string type in version 3.10.6.

5
doc/mkdocs/docs/api/json_pointer/json_pointer.md
View File

@ -1,7 +1,7 @@
# <small>nlohmann::json_pointer::</small>json_pointer # <small>nlohmann::json_pointer::</small>json_pointer
```cpp ```cpp
explicit json_pointer(const std::string& s = ""); explicit json_pointer(const string_t& s = "");
``` ```
Create a JSON pointer according to the syntax described in Create a JSON pointer according to the syntax described in
@ -37,4 +37,5 @@ Create a JSON pointer according to the syntax described in
## Version history ## Version history
Added in version 2.0.0. - Added in version 2.0.0.
- Changed type of `s` to `string_t` in version 3.10.6.

4
doc/mkdocs/docs/api/json_pointer/operator_slash.md
View File

@ -5,7 +5,7 @@
json_pointer operator/(const json_pointer& lhs, const json_pointer& rhs); json_pointer operator/(const json_pointer& lhs, const json_pointer& rhs);
// (2) // (2)
json_pointer operator/(const json_pointer& lhs, std::string token); json_pointer operator/(const json_pointer& lhs, string_t token);
// (3) // (3)
json_pointer operator/(const json_pointer& lhs, std::size_t array_idx); json_pointer operator/(const json_pointer& lhs, std::size_t array_idx);
@ -60,5 +60,5 @@ json_pointer operator/(const json_pointer& lhs, std::size_t array_idx);
## Version history ## Version history
1. Added in version 3.6.0. 1. Added in version 3.6.0.
2. Added in version 3.6.0. 2. Added in version 3.6.0. Changed type of `token` to `string_t` in version 3.10.6.
3. Added in version 3.6.0. 3. Added in version 3.6.0.

4
doc/mkdocs/docs/api/json_pointer/operator_slasheq.md
View File

@ -5,7 +5,7 @@
json_pointer& operator/=(const json_pointer& ptr); json_pointer& operator/=(const json_pointer& ptr);
// (2) // (2)
json_pointer& operator/=(std::string token); json_pointer& operator/=(string_t token);
// (3) // (3)
json_pointer& operator/=(std::size_t array_idx) json_pointer& operator/=(std::size_t array_idx)
@ -57,5 +57,5 @@ json_pointer& operator/=(std::size_t array_idx)
## Version history ## Version history
1. Added in version 3.6.0. 1. Added in version 3.6.0.
2. Added in version 3.6.0. 2. Added in version 3.6.0. Changed type of `token` to `string_t` in version 3.10.6.
3. Added in version 3.6.0. 3. Added in version 3.6.0.

9
doc/mkdocs/docs/api/json_pointer/operator_string.md
View File

@ -1,7 +1,7 @@
# <small>nlohmann::json_pointer::</small>operator std::string # <small>nlohmann::json_pointer::</small>operator string_t
```cpp ```cpp
operator std::string() const operator string_t() const
``` ```
Return a string representation of the JSON pointer. Return a string representation of the JSON pointer.
@ -13,7 +13,7 @@ A string representation of the JSON pointer
## Possible implementation ## Possible implementation
```cpp ```cpp
operator std::string() const operator string_t() const
{ {
return to_string(); return to_string();
} }
@ -21,4 +21,5 @@ operator std::string() const
## Version history ## Version history
Since version 2.0.0. - Since version 2.0.0.
- Changed type to `string_t`.

7
doc/mkdocs/docs/api/json_pointer/push_back.md
View File

@ -1,9 +1,9 @@
# <small>nlohmann::json_pointer::</small>push_back # <small>nlohmann::json_pointer::</small>push_back
```cpp ```cpp
void push_back(const std::string& token); void push_back(const string_t& token);
void push_back(std::string&& token); void push_back(string_t&& token);
``` ```
Append an unescaped token at the end of the reference pointer. Append an unescaped token at the end of the reference pointer.
@ -35,4 +35,5 @@ Amortized constant.
## Version history ## Version history
Added in version 3.6.0. - Added in version 3.6.0.
- Changed type of `token` to `string_t` in version 3.10.6.

12
doc/mkdocs/docs/api/json_pointer/string_t.md Normal file
View File

@ -0,0 +1,12 @@
# <small>nlohmann::json_pointer::</small>string_t
```cpp
using string_t = RefStringType;
```
The string type used for the reference tokens making up the JSON pointer.
See [`basic_json::string_t`](../basic_json/string_t.md) for more information.
## Version history
- Added in version 3.10.6.

5
doc/mkdocs/docs/api/json_pointer/to_string.md
View File

@ -1,7 +1,7 @@
# <small>nlohmann::json_pointer::</small>to_string # <small>nlohmann::json_pointer::</small>to_string
```cpp ```cpp
std::string to_string() const; string_t to_string() const;
``` ```
Return a string representation of the JSON pointer. Return a string representation of the JSON pointer.
@ -36,4 +36,5 @@ ptr == json_pointer(ptr.to_string());
## Version history ## Version history
Since version 2.0.0. - Since version 2.0.0.
- Changed return type to `string_t` in version 3.10.6.

1
doc/mkdocs/mkdocs.yml
View File

@ -211,6 +211,7 @@ nav:
- 'parent_pointer': api/json_pointer/parent_pointer.md - 'parent_pointer': api/json_pointer/parent_pointer.md
- 'pop_back': api/json_pointer/pop_back.md - 'pop_back': api/json_pointer/pop_back.md
- 'push_back': api/json_pointer/push_back.md - 'push_back': api/json_pointer/push_back.md
- 'string_t': api/json_pointer/string_t.md
- 'to_string': api/json_pointer/to_string.md - 'to_string': api/json_pointer/to_string.md
- json_sax: - json_sax:
- 'Overview': api/json_sax/index.md - 'Overview': api/json_sax/index.md