Skip to content

Commit 082c04f

Browse files
authored
Merge pull request dotnet#8420 from gewarren/remove-internal-only
Fix up STJ comments
2 parents 461507e + 5bfff12 commit 082c04f

File tree

4 files changed

+18
-39
lines changed

4 files changed

+18
-39
lines changed

xml/System.Text.Json.Serialization.Metadata/JsonObjectInfoValues`1.xml

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,7 @@
2626
<Docs>
2727
<typeparam name="T">The object type to serialize or deserialize.</typeparam>
2828
<summary>Provides serialization metadata about an object type with constructors, properties, and fields.</summary>
29-
<remarks>
30-
<format type="text/markdown"><![CDATA[
31-
32-
## Remarks
33-
34-
This API is intended for use by the output of the System.Text.Json source generator and should not be called directly.
35-
36-
]]></format>
37-
</remarks>
29+
<remarks>This API is intended for use by the output of the System.Text.Json source generator and should not be called directly.</remarks>
3830
</Docs>
3931
<Members>
4032
<Member MemberName=".ctor">

xml/System.Text.Json.Serialization.Metadata/JsonParameterInfoValues.xml

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,7 @@
2222
</Attributes>
2323
<Docs>
2424
<summary>Provides information about a constructor parameter required for JSON deserialization.</summary>
25-
<remarks>
26-
<format type="text/markdown"><![CDATA[
27-
28-
## Remarks
29-
30-
This API is intended for use by the output of the System.Text.Json source generator and should not be called directly.
31-
32-
]]></format>
33-
</remarks>
25+
<remarks>This API is intended for use by the output of the System.Text.Json source generator and should not be called directly.</remarks>
3426
</Docs>
3527
<Members>
3628
<Member MemberName=".ctor">

xml/System.Text.Json.Serialization.Metadata/JsonPropertyInfo.xml

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,7 @@
1616
<Interfaces />
1717
<Docs>
1818
<summary>Provides JSON serialization-related metadata about a property or field.</summary>
19-
<remarks>
20-
<format type="text/markdown"><![CDATA[
21-
22-
## Remarks
23-
24-
This API is intended for use by the output of the System.Text.Json source generator and should not be called directly.
25-
26-
]]></format>
27-
</remarks>
19+
<remarks>To be added.</remarks>
2820
</Docs>
2921
<Members>
3022
<Member MemberName="AttributeProvider">
@@ -177,10 +169,21 @@ The current <see cref="P:System.Text.Json.Serialization.Metadata.JsonPropertyInf
177169
<Docs>
178170
<summary>Gets or sets a value that indicates whether the current property is required for deserialization to be successful.</summary>
179171
<value>To be added.</value>
180-
<remarks>For contracts originating from <see cref="T:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver" /> or <see cref="T:System.Text.Json.Serialization.JsonSerializerContext" />, the value of this property will be mapped from <see cref="T:System.Text.Json.Serialization.JsonRequiredAttribute" /> annotations.
181-
For contracts using <see cref="T:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver" />, the value of this property will also map from properties that have the <see langword="required" /> modifier, unless deserialization uses a constructor that populates all required properties and that has <see cref="T:System.Diagnostics.CodeAnalysis.SetsRequiredMembersAttribute" />.
182-
<see langword="required" /> keyword is currently not supported in <see cref="T:System.Text.Json.Serialization.JsonSerializerContext" /> contracts.</remarks>
172+
<remarks>
173+
<format type="text/markdown"><![CDATA[
174+
175+
## Remarks
176+
177+
For contracts that originate from <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver> or <xref:System.Text.Json.Serialization.JsonSerializerContext>, the value of this property is mapped from <xref:System.Text.Json.Serialization.JsonRequiredAttribute> annotations.
178+
179+
For contracts that use <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver>, the value of this property is also mapped from properties that have the `required` modifier, unless deserialization uses a constructor that populates all required properties and has <xref:System.Diagnostics.CodeAnalysis.SetsRequiredMembersAttribute>.
180+
181+
The `required` keyword is currently not supported in <xref:System.Text.Json.Serialization.JsonSerializerContext> contracts.
182+
183+
]]></format>
184+
</remarks>
183185
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Text.Json.Serialization.Metadata.JsonPropertyInfo" /> instance has been locked for further modification.</exception>
186+
<related type="Article" href="/dotnet/standard/serialization/system-text-json/required-properties">Required properties</related>
184187
</Docs>
185188
</Member>
186189
<Member MemberName="Name">

xml/System.Text.Json.Serialization.Metadata/JsonTypeInfo.xml

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,7 @@
2020
<Interfaces />
2121
<Docs>
2222
<summary>Provides JSON serialization-related metadata about a type.</summary>
23-
<remarks>
24-
<format type="text/markdown"><![CDATA[
25-
26-
## Remarks
27-
28-
This API is intended for use by the output of the System.Text.Json source generator and should not be called directly.
29-
30-
]]></format>
31-
</remarks>
23+
<remarks>To be added.</remarks>
3224
</Docs>
3325
<Members>
3426
<Member MemberName="Converter">

0 commit comments

Comments
 (0)