Skip to content

Commit 3b198df

Browse files
gregsdennisgregsdennis
committed
docs are generating (trouble with tables)
1 parent 4d2697a commit 3b198df

File tree

335 files changed

+24599
-0
lines changed

Some content is hidden

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

335 files changed

+24599
-0
lines changed

‎.editorconfig

+4
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,7 @@ quote_type = double
1717

1818
[*.md]
1919
trim_trailing_whitespace = false
20+
21+
[*.cs]
22+
indent_size = 4
23+
indent_style = tab

‎_docs/api/Json.More/EnumStringConverter`1.md

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
layout: "page"
3+
title: "EnumStringConverter<T> Class"
4+
bookmark: "EnumStringConverter`1"
5+
permalink: "/api/Json.More/:title/"
6+
order: "9.11.00"
7+
---
8+
**Namespace:** Json.More
9+
10+
**Inheritance:**
11+
`EnumStringConverter<T>`
12+
🡒
13+
`JsonConverter<T>`
14+
🡒
15+
`JsonConverter`
16+
🡒
17+
`object`
18+
19+
20+
## Properties
21+
22+
| Name | Type | Summary |
23+
|---|---|---|
24+
| **HandleNull** | bool | |
25+
## Methods
26+
27+
### Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
28+
29+
Reads and converts the JSON to type <typeparamref name="T" />.
30+
31+
#### Declaration
32+
33+
```c#
34+
public override T Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
35+
```
36+
| Parameter | Type | Description |
37+
|---|---|---|
38+
| reader | ref Utf8JsonReader | The reader. |
39+
| typeToConvert | Type | The type to convert. |
40+
| options | JsonSerializerOptions | An object that specifies serialization options to use. |
41+
42+
#### Returns
43+
44+
The converted value.
45+
46+
### ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
47+
48+
Reads a dictionary key from a JSON property name.
49+
50+
#### Declaration
51+
52+
```c#
53+
public override T ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
54+
```
55+
| Parameter | Type | Description |
56+
|---|---|---|
57+
| reader | ref Utf8JsonReader | The **System.Text.Json.Utf8JsonReader** to read from. |
58+
| typeToConvert | Type | The type to convert. |
59+
| options | JsonSerializerOptions | The options to use when reading the value. |
60+
61+
#### Returns
62+
63+
The value that was converted.
64+
65+
### Write(Utf8JsonWriter writer, T value, JsonSerializerOptions options)
66+
67+
Writes a specified value as JSON.
68+
69+
#### Declaration
70+
71+
```c#
72+
public override void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions options)
73+
```
74+
| Parameter | Type | Description |
75+
|---|---|---|
76+
| writer | Utf8JsonWriter | The writer to write to. |
77+
| value | T | The value to convert to JSON. |
78+
| options | JsonSerializerOptions | An object that specifies serialization options to use. |
79+
80+
### WriteAsPropertyName(Utf8JsonWriter writer, T value, JsonSerializerOptions options)
81+
82+
Writes a dictionary key as a JSON property name.
83+
84+
#### Declaration
85+
86+
```c#
87+
public override void WriteAsPropertyName(Utf8JsonWriter writer, T value, JsonSerializerOptions options)
88+
```
89+
| Parameter | Type | Description |
90+
|---|---|---|
91+
| writer | Utf8JsonWriter | The **System.Text.Json.Utf8JsonWriter** to write to. |
92+
| value | T | The value to convert. The value of **System.Text.Json.Serialization.JsonConverter`1.HandleNull** determines if the converter handles \<see langword="null" /\> values. |
93+
| options | JsonSerializerOptions | The options to use when writing the value. |
94+

‎_docs/api/Json.More/JsonDocumentEqualityComparer.md

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
layout: "page"
3+
title: "JsonDocumentEqualityComparer Class"
4+
bookmark: "JsonDocumentEqualityComparer"
5+
permalink: "/api/Json.More/:title/"
6+
order: "9.11.01"
7+
---
8+
**Namespace:** Json.More
9+
10+
**Inheritance:**
11+
`JsonDocumentEqualityComparer`
12+
🡒
13+
`object`
14+
15+
**Implemented interfaces:**
16+
17+
- IEqualityComparer\<JsonDocument\>
18+
19+
Calculates equality between two **System.Text.Json.JsonDocument**s.
20+
21+
## Remarks
22+
23+
This comparison is compliant with the ideals expressed by JSON:
24+
25+
- Objects are unordered.
26+
- Arrays are ordered.
27+
28+
## Properties
29+
30+
| Name | Type | Summary |
31+
|---|---|---|
32+
| **Instance** | JsonDocumentEqualityComparer | A singleton instance for convenience. |
33+
## Methods
34+
35+
### Equals(JsonDocument x, JsonDocument y)
36+
37+
Determines whether the specified objects are equal.
38+
39+
#### Declaration
40+
41+
```c#
42+
public bool Equals(JsonDocument x, JsonDocument y)
43+
```
44+
| Parameter | Type | Description |
45+
|---|---|---|
46+
| x | JsonDocument | The first object of type T to compare. |
47+
| y | JsonDocument | The second object of type T to compare. |
48+
49+
#### Returns
50+
51+
true if the specified objects are equal; otherwise, false.
52+
53+
### GetHashCode(JsonDocument obj)
54+
55+
Returns a hash code for the specified object.
56+
57+
#### Declaration
58+
59+
```c#
60+
public int GetHashCode(JsonDocument obj)
61+
```
62+
| Parameter | Type | Description |
63+
|---|---|---|
64+
| obj | JsonDocument | The **System.Object** for which a hash code is to be returned. |
65+
66+
#### Returns
67+
68+
A hash code for the specified object.
69+

‎_docs/api/Json.More/JsonDocumentExtensions.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
layout: "page"
3+
title: "JsonDocumentExtensions Class"
4+
bookmark: "JsonDocumentExtensions"
5+
permalink: "/api/Json.More/:title/"
6+
order: "9.11.02"
7+
---
8+
**Namespace:** Json.More
9+
10+
**Inheritance:**
11+
`JsonDocumentExtensions`
12+
🡒
13+
`object`
14+
15+
Provides extension functionality for **System.Text.Json.JsonDocument**.
16+
17+
## Methods
18+
19+
### IsEquivalentTo(this JsonDocument a, JsonDocument b)
20+
21+
Determines JSON-compatible equivalence.
22+
23+
#### Declaration
24+
25+
```c#
26+
public static bool IsEquivalentTo(this JsonDocument a, JsonDocument b)
27+
```
28+
| Parameter | Type | Description |
29+
|---|---|---|
30+
| a | JsonDocument | The first document. |
31+
| b | JsonDocument | The second document. |
32+
33+
#### Returns
34+
35+
`true` if the documents are equivalent; `false` otherwise.
36+
37+
### ToJsonDocument(this T value, JsonSerializerOptions options)
38+
39+
Converts an object to a **System.Text.Json.JsonDocument**.
40+
41+
#### Declaration
42+
43+
```c#
44+
public static JsonDocument ToJsonDocument(this T value, JsonSerializerOptions options)
45+
```
46+
| Parameter | Type | Description |
47+
|---|---|---|
48+
| value | T | The value to convert. |
49+
| options | JsonSerializerOptions | (optional) JSON serialization options. |
50+
51+
#### Returns
52+
53+
A **System.Text.Json.JsonDocument** representing the vale.
54+

‎_docs/api/Json.More/JsonElementEqualityComparer.md

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
layout: "page"
3+
title: "JsonElementEqualityComparer Class"
4+
bookmark: "JsonElementEqualityComparer"
5+
permalink: "/api/Json.More/:title/"
6+
order: "9.11.03"
7+
---
8+
**Namespace:** Json.More
9+
10+
**Inheritance:**
11+
`JsonElementEqualityComparer`
12+
🡒
13+
`object`
14+
15+
**Implemented interfaces:**
16+
17+
- IEqualityComparer\<JsonElement\>
18+
19+
Calculates equality between two **System.Text.Json.JsonElement**s.
20+
21+
## Remarks
22+
23+
This comparison is compliant with the ideals expressed by JSON:
24+
25+
- Objects are unordered.
26+
- Arrays are ordered.
27+
28+
## Properties
29+
30+
| Name | Type | Summary |
31+
|---|---|---|
32+
| **Instance** | JsonElementEqualityComparer | A singleton instance for convenience. |
33+
## Methods
34+
35+
### Equals(JsonElement x, JsonElement y)
36+
37+
Determines whether the specified objects are equal.
38+
39+
#### Declaration
40+
41+
```c#
42+
public bool Equals(JsonElement x, JsonElement y)
43+
```
44+
| Parameter | Type | Description |
45+
|---|---|---|
46+
| x | JsonElement | The first object of type T to compare. |
47+
| y | JsonElement | The second object of type T to compare. |
48+
49+
#### Returns
50+
51+
true if the specified objects are equal; otherwise, false.
52+
53+
### GetHashCode(JsonElement obj)
54+
55+
Returns a hash code for the specified object.
56+
57+
#### Declaration
58+
59+
```c#
60+
public int GetHashCode(JsonElement obj)
61+
```
62+
| Parameter | Type | Description |
63+
|---|---|---|
64+
| obj | JsonElement | The **System.Object** for which a hash code is to be returned. |
65+
66+
#### Returns
67+
68+
A hash code for the specified object.
69+

0 commit comments

Comments
 (0)