Skip to content

Commit 97e43a8

Browse files
author
json-everything-ci
committed
regenerated api docs
1 parent 866be5f commit 97e43a8

File tree

198 files changed

+886
-739
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

198 files changed

+886
-739
lines changed

_docs/api/JsonPatch.Net/title.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ bookmark: JsonPatch.Net
44
permalink: /api/JsonPatch.Net/:title/
55
folder: true
66
order: "10.09"
7-
version: "3.0.0"
7+
version: "3.1.0"
88
---

_docs/api/JsonPointer.Net/JsonPointer.md

Lines changed: 73 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ order: "10.10.001"
1515
**Implemented interfaces:**
1616

1717
- IEquatable\<JsonPointer\>
18+
- IReadOnlyList\<string\>
19+
- IReadOnlyCollection\<string\>
20+
- IEnumerable\<string\>
21+
- IEnumerable
1822

1923
Represents a JSON Pointer IAW RFC 6901.
2024

@@ -28,7 +32,9 @@ Represents a JSON Pointer IAW RFC 6901.
2832

2933
| Name | Type | Summary |
3034
|---|---|---|
31-
| **Segments** | PointerSegment[] | Gets the collection of pointer segments. |
35+
| **Count** | int | Gets the number of segments in the pointer. |
36+
| **Item** | string | Gets a segment value by index. |
37+
| **Item** | JsonPointer | Creates a new pointer with the indicated segments. |
3238

3339
## Methods
3440

@@ -93,25 +99,6 @@ The JSON Pointer.
9399

94100
This method creates un-encoded pointers only.
95101

96-
### Create(IEnumerable\<PointerSegment\> segments)
97-
98-
Creates a new JSON Pointer from a collection of segments.
99-
100-
#### Declaration
101-
102-
```c#
103-
public static JsonPointer Create(IEnumerable<PointerSegment> segments)
104-
```
105-
106-
| Parameter | Type | Description |
107-
|---|---|---|
108-
| segments | IEnumerable\<PointerSegment\> | A collection of segments. |
109-
110-
111-
#### Returns
112-
113-
The JSON Pointer.
114-
115102
### Create(Expression\<Func\<T, object\>\> expression, PointerCreationOptions options)
116103

117104
Generates a JSON Pointer from a lambda expression.
@@ -189,6 +176,40 @@ public JsonElement? Evaluate(JsonElement root)
189176

190177
The sub-element at the pointer's location, or null if the path does not exist.
191178

179+
### GetAncestor(int levels)
180+
181+
Creates a new pointer retaining the starting segments.
182+
183+
#### Declaration
184+
185+
```c#
186+
public JsonPointer GetAncestor(int levels)
187+
```
188+
189+
| Parameter | Type | Description |
190+
|---|---|---|
191+
| levels | int | How many levels to remove from the end of the pointer. |
192+
193+
194+
#### Returns
195+
196+
A new pointer.
197+
198+
### GetEnumerator()
199+
200+
Returns an enumerator that iterates through the collection.
201+
202+
#### Declaration
203+
204+
```c#
205+
public IEnumerator<string> GetEnumerator()
206+
```
207+
208+
209+
#### Returns
210+
211+
An enumerator that can be used to iterate through the collection.
212+
192213
### GetHashCode()
193214

194215
Returns the hash code for this instance.
@@ -204,53 +225,72 @@ public override int GetHashCode()
204225

205226
A 32-bit signed integer that is the hash code for this instance.
206227

207-
### Parse(string source)
228+
### GetLocal(int levels)
208229

209-
Parses a JSON Pointer from a string.
230+
Creates a new pointer retaining the ending segments.
210231

211232
#### Declaration
212233

213234
```c#
214-
public static JsonPointer Parse(string source)
235+
public JsonPointer GetLocal(int levels)
215236
```
216237

217238
| Parameter | Type | Description |
218239
|---|---|---|
219-
| source | string | The source string. |
240+
| levels | int | How many levels to keep from the end of the pointer. |
220241

221242

222243
#### Returns
223244

224-
A JSON Pointer.
245+
A new pointer.
225246

226-
### ToString()
247+
### GetSubPointer(Range range)
227248

228-
Returns the string representation of this instance.
249+
Creates a new pointer with the indicated segments.
229250

230251
#### Declaration
231252

232253
```c#
233-
public override string ToString()
254+
public JsonPointer GetSubPointer(Range range)
234255
```
235256

257+
| Parameter | Type | Description |
258+
|---|---|---|
259+
| range | Range | The segment range for the new pointer. |
260+
236261

237262
#### Returns
238263

239-
The string representation.
264+
A new pointer.
240265

241-
### ToString(JsonPointerStyle pointerStyle)
266+
### Parse(string source)
242267

243-
Returns the string representation of this instance.
268+
Parses a JSON Pointer from a string.
244269

245270
#### Declaration
246271

247272
```c#
248-
public string ToString(JsonPointerStyle pointerStyle)
273+
public static JsonPointer Parse(string source)
249274
```
250275

251276
| Parameter | Type | Description |
252277
|---|---|---|
253-
| pointerStyle | JsonPointerStyle | Indicates whether to URL-encode the pointer. |
278+
| source | string | The source string. |
279+
280+
281+
#### Returns
282+
283+
A JSON Pointer.
284+
285+
### ToString()
286+
287+
Returns the string representation of this instance.
288+
289+
#### Declaration
290+
291+
```c#
292+
public override string ToString()
293+
```
254294

255295

256296
#### Returns

_docs/api/JsonPointer.Net/JsonPointerStyle.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

_docs/api/JsonPointer.Net/PointerCreationOptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "PointerCreationOptions Class"
44
bookmark: "PointerCreationOptions"
55
permalink: "/api/JsonPointer.Net/:title/"
6-
order: "10.10.004"
6+
order: "10.10.003"
77
---
88
**Namespace:** Json.Pointer
99

_docs/api/JsonPointer.Net/PointerParseException.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "PointerParseException Class"
44
bookmark: "PointerParseException"
55
permalink: "/api/JsonPointer.Net/:title/"
6-
order: "10.10.005"
6+
order: "10.10.004"
77
---
88
**Namespace:** Json.Pointer
99

Lines changed: 9 additions & 132 deletions
Original file line numberDiff line numberDiff line change
@@ -1,158 +1,35 @@
11
---
22
layout: "page"
3-
title: "PointerSegment Class"
3+
title: "PointerSegment Struct"
44
bookmark: "PointerSegment"
55
permalink: "/api/JsonPointer.Net/:title/"
6-
order: "10.10.006"
6+
order: "10.10.005"
77
---
88
**Namespace:** Json.Pointer
99

1010
**Inheritance:**
1111
`PointerSegment`
1212
🡒
13+
`ValueType`
14+
🡒
1315
`object`
1416

15-
**Implemented interfaces:**
16-
17-
- IEquatable\<PointerSegment\>
18-
19-
Represents a single segment of a JSON Pointer.
20-
21-
## Properties
22-
23-
| Name | Type | Summary |
24-
|---|---|---|
25-
| **Value** | string | Gets the segment value. |
17+
Serves as an intermediary for creating JSON Pointers by segments.
2618

2719
## Methods
2820

29-
### Create(string value)
30-
31-
Creates a new **Json.Pointer.PointerSegment**.
32-
33-
#### Declaration
34-
35-
```c#
36-
public static PointerSegment Create(string value)
37-
```
38-
39-
| Parameter | Type | Description |
40-
|---|---|---|
41-
| value | string | The value. |
42-
43-
44-
#### Returns
45-
46-
47-
48-
### Equals(PointerSegment other)
49-
50-
Indicates whether the current object is equal to another object of the same type.
51-
52-
#### Declaration
53-
54-
```c#
55-
public bool Equals(PointerSegment other)
56-
```
57-
58-
| Parameter | Type | Description |
59-
|---|---|---|
60-
| other | PointerSegment | An object to compare with this object. |
61-
62-
63-
#### Returns
64-
65-
true if the current object is equal to the <paramref name="other">other</paramref> parameter; otherwise, false.
66-
67-
### Equals(object obj)
68-
69-
Indicates whether this instance and a specified object are equal.
70-
71-
#### Declaration
72-
73-
```c#
74-
public override bool Equals(object obj)
75-
```
76-
77-
| Parameter | Type | Description |
78-
|---|---|---|
79-
| obj | object | The object to compare with the current instance. |
80-
81-
82-
#### Returns
83-
84-
true if <paramref name="obj">obj</paramref> and this instance are the same type and represent the same value; otherwise, false.
85-
86-
### GetHashCode()
87-
88-
Returns the hash code for this instance.
89-
90-
#### Declaration
91-
92-
```c#
93-
public override int GetHashCode()
94-
```
95-
21+
### ToString()
9622

97-
#### Returns
98-
99-
A 32-bit signed integer that is the hash code for this instance.
100-
101-
### Parse(string source)
102-
103-
Parses a JSON Pointer segment from a string.
23+
Returns the fully qualified type name of this instance.
10424

10525
#### Declaration
10626

10727
```c#
108-
public static PointerSegment Parse(string source)
28+
public override string ToString()
10929
```
11030

111-
| Parameter | Type | Description |
112-
|---|---|---|
113-
| source | string | The source string. |
114-
115-
116-
#### Returns
117-
118-
A JSON Pointer segment.
119-
120-
### ToString(JsonPointerStyle pointerStyle)
121-
122-
Returns the string representation of this instance.
123-
124-
#### Declaration
125-
126-
```c#
127-
public string ToString(JsonPointerStyle pointerStyle)
128-
```
129-
130-
| Parameter | Type | Description |
131-
|---|---|---|
132-
| pointerStyle | JsonPointerStyle | Indicates whether to URL-encode the pointer. |
133-
134-
135-
#### Returns
136-
137-
The string representation.
138-
139-
### TryParse(string source, out PointerSegment segment)
140-
141-
Parses a JSON Pointer segment from a string.
142-
143-
#### Declaration
144-
145-
```c#
146-
public static bool TryParse(string source, out PointerSegment segment)
147-
```
148-
149-
| Parameter | Type | Description |
150-
|---|---|---|
151-
| source | string | The source string. |
152-
| segment | out PointerSegment | The resulting segments. |
153-
15431

15532
#### Returns
15633

157-
`true` if the parse was successful; `false` otherwise.
34+
The fully qualified type name.
15835

_docs/api/JsonPointer.Net/PropertyNameResolver.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "PropertyNameResolver Delegate"
44
bookmark: "PropertyNameResolver"
55
permalink: "/api/JsonPointer.Net/:title/"
6-
order: "10.10.007"
6+
order: "10.10.006"
77
---
88
# PropertyNameResolver Delegate
99

0 commit comments

Comments
 (0)