Skip to content

Commit 65790d4

Browse files
authored
Fix typo and para tags (#10584)
1 parent f02e675 commit 65790d4

File tree

1 file changed

+16
-39
lines changed

1 file changed

+16
-39
lines changed

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

Lines changed: 16 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,8 @@
5656
<summary>Gets the constructor parameter associated with the current property.</summary>
5757
<value>To be added.</value>
5858
<remarks>
59-
<para>Returns the <see cref="T:System.Text.Json.Serialization.Metadata.JsonParameterInfo" /> metadata for the parameter in the</para>
60-
<para>deserialization constructor that has been associated with the current property.</para>
61-
<para>A constructor parameter is matched to a property or field if they are of the</para>
62-
<para>same type and have the same name, up to case insensitivity. Each constructor</para>
63-
<para>parameter must be matched to exactly one property of field.</para>
59+
<para>Returns the <see cref="T:System.Text.Json.Serialization.Metadata.JsonParameterInfo" /> metadata for the parameter in the deserialization constructor that has been associated with the current property.</para>
60+
<para>A constructor parameter is matched to a property or field if they are of the same type and have the same (case-insensitive) name. Each constructor parameter must be matched to exactly one property or field.</para>
6461
</remarks>
6562
</Docs>
6663
</Member>
@@ -94,11 +91,9 @@
9491
9592
## Remarks
9693
97-
When resolving metadata via <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver>, this property
98-
will be populated with the underlying <xref:System.Reflection.MemberInfo> of the serialized property or field.
94+
When resolving metadata via <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver> or <xref:System.Text.Json.Serialization.JsonSerializerContext>, this property will be populated with the underlying <xref:System.Reflection.MemberInfo> of the serialized property or field.
9995
100-
Setting a custom attribute provider has no impact on the contract model
101-
but serves as metadata for downstream contract modifiers.
96+
Setting a custom attribute provider has no impact on the contract model but serves as metadata for downstream contract modifiers.
10297
10398
]]></format>
10499
</remarks>
@@ -135,10 +130,9 @@ Setting a custom attribute provider has no impact on the contract model
135130
136131
## Remarks
137132
138-
It is possible to use <xref:System.Text.Json.Serialization.JsonConverterFactory> instances with this property.
133+
It's possible to use <xref:System.Text.Json.Serialization.JsonConverterFactory> instances with this property.
139134
140-
For contracts originating from <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver>, the value of
141-
<xref:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.CustomConverter> will be mapped from <xref:System.Text.Json.Serialization.JsonConverterAttribute> annotations.
135+
For contracts originating from <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver>, the value of <xref:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.CustomConverter> will be mapped from <xref:System.Text.Json.Serialization.JsonConverterAttribute> annotations.
142136
143137
]]></format>
144138
</remarks>
@@ -225,10 +219,7 @@ Setting to `null` will result in the property being skipped on serialization.
225219
<remarks>
226220
<format type="text/markdown"><![CDATA[
227221
228-
## Remarks
229-
230-
For contracts originating from <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver> or <xref:System.Text.Json.Serialization.JsonSerializerContext>,
231-
the value of this property will be mapped from <xref:System.Text.Json.Serialization.JsonExtensionDataAttribute> annotations.
222+
For contracts originating from <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver> or <xref:System.Text.Json.Serialization.JsonSerializerContext>, the value of this property will be mapped from <xref:System.Text.Json.Serialization.JsonExtensionDataAttribute> annotations.
232223
233224
]]></format>
234225
</remarks>
@@ -258,11 +249,8 @@ The current <see cref="P:System.Text.Json.Serialization.Metadata.JsonPropertyInf
258249
<summary>Gets or sets a value indicating whether the return type of the getter is annotated as nullable.</summary>
259250
<value>To be added.</value>
260251
<remarks>
261-
<para>Contracts originating from <see cref="T:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver" /> or <see cref="T:System.Text.Json.Serialization.JsonSerializerContext" />,</para>
262-
<para>derive the value of this property from nullable reference type annotations, including annotations</para>
263-
<para>from attributes such as <see cref="T:System.Diagnostics.CodeAnalysis.NotNullAttribute" /> or <see cref="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute" />.</para>
264-
<para>This property has no effect on serialization unless the <see cref="P:System.Text.Json.JsonSerializerOptions.RespectNullableAnnotations" /></para>
265-
<para>property has been enabled, in which case the serializer will reject any <see langword="null" /> values returned by the getter.</para>
252+
<para>Contracts originating from <see cref="T:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver" /> or <see cref="T:System.Text.Json.Serialization.JsonSerializerContext" />, derive the value of this property from nullable reference type annotations, including annotations from attributes such as <see cref="T:System.Diagnostics.CodeAnalysis.NotNullAttribute" /> or <see cref="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute" />.</para>
253+
<para>This property has no effect on serialization unless the <see cref="P:System.Text.Json.JsonSerializerOptions.RespectNullableAnnotations" /> property has been enabled, in which case the serializer will reject any <see langword="null" /> values returned by the getter.</para>
266254
</remarks>
267255
<exception cref="T:System.InvalidOperationException">
268256
<para>The <see cref="T:System.Text.Json.Serialization.Metadata.JsonPropertyInfo" /> instance has been locked for further modification.</para>
@@ -326,13 +314,9 @@ The `required` keyword is currently not supported in <xref:System.Text.Json.Seri
326314
<summary>Gets or sets a value indicating whether the input type of the setter is annotated as nullable.</summary>
327315
<value>To be added.</value>
328316
<remarks>
329-
<para>Contracts originating from <see cref="T:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver" /> or <see cref="T:System.Text.Json.Serialization.JsonSerializerContext" />,</para>
330-
<para>derive the value of this property from nullable reference type annotations, including annotations</para>
331-
<para>from attributes such as <see cref="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute" /> or <see cref="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute" />.</para>
332-
<para>This property has no effect on deserialization unless the <see cref="P:System.Text.Json.JsonSerializerOptions.RespectNullableAnnotations" /></para>
333-
<para>property has been enabled, in which case the serializer will reject any <see langword="null" /> deserialization results.</para>
334-
<para>If the property has been associated with a deserialization constructor parameter,</para>
335-
<para>this setting reflected the nullability annotation of the parameter and not the property setter.</para>
317+
<para>Contracts originating from <see cref="T:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver" /> or <see cref="T:System.Text.Json.Serialization.JsonSerializerContext" />, derive the value of this property from nullable reference type annotations, including annotations from attributes such as <see cref="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute" /> or <see cref="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute" />.</para>
318+
<para>This property has no effect on deserialization unless the <see cref="P:System.Text.Json.JsonSerializerOptions.RespectNullableAnnotations" /> property has been enabled, in which case the serializer will reject any <see langword="null" /> deserialization results.</para>
319+
<para>If the property has been associated with a deserialization constructor parameter, this setting reflected the nullability annotation of the parameter and not the property setter.</para>
336320
</remarks>
337321
<exception cref="T:System.InvalidOperationException">
338322
<para>The <see cref="T:System.Text.Json.Serialization.Metadata.JsonPropertyInfo" /> instance has been locked for further modification.</para>
@@ -367,9 +351,7 @@ The `required` keyword is currently not supported in <xref:System.Text.Json.Seri
367351
368352
The value of <xref:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.Name> cannot conflict with that of other <xref:System.Text.Json.Serialization.Metadata.JsonPropertyInfo> defined in the declaring <xref:System.Text.Json.Serialization.Metadata.JsonTypeInfo>.
369353
370-
For contracts originating from <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver> or <xref:System.Text.Json.Serialization.JsonSerializerContext>,
371-
the value typically reflects the underlying .NET member name, the name derived from <xref:System.Text.Json.JsonSerializerOptions.PropertyNamingPolicy>,
372-
or the value specified in <xref:System.Text.Json.Serialization.JsonPropertyNameAttribute>.
354+
For contracts originating from <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver> or <xref:System.Text.Json.Serialization.JsonSerializerContext>, the value typically reflects the underlying .NET member name, the name derived from <xref:System.Text.Json.JsonSerializerOptions.PropertyNamingPolicy>, or the value specified in <xref:System.Text.Json.Serialization.JsonPropertyNameAttribute>.
373355
374356
]]></format>
375357
</remarks>
@@ -400,10 +382,7 @@ For contracts originating from <xref:System.Text.Json.Serialization.Metadata.Def
400382
<remarks>
401383
<format type="text/markdown"><![CDATA[
402384
403-
## Remarks
404-
405-
For contracts originating from <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver> or <xref:System.Text.Json.Serialization.JsonSerializerContext>,
406-
the value of this property will be mapped from <xref:System.Text.Json.Serialization.JsonNumberHandlingAttribute> annotations.
385+
For contracts originating from <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver> or <xref:System.Text.Json.Serialization.JsonSerializerContext>, the value of this property will be mapped from <xref:System.Text.Json.Serialization.JsonNumberHandlingAttribute> annotations.
407386
408387
]]></format>
409388
</remarks>
@@ -480,8 +459,7 @@ For contracts originating from <xref:System.Text.Json.Serialization.Metadata.Def
480459
481460
## Remarks
482461
483-
For contracts originating from <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver> or <xref:System.Text.Json.Serialization.JsonSerializerContext>,
484-
the value of this property will be mapped from <xref:System.Text.Json.Serialization.JsonPropertyOrderAttribute> annotations.
462+
For contracts originating from <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver> or <xref:System.Text.Json.Serialization.JsonSerializerContext>, the value of this property will be mapped from <xref:System.Text.Json.Serialization.JsonPropertyOrderAttribute> annotations.
485463
486464
]]></format>
487465
</remarks>
@@ -581,8 +559,7 @@ The first parameter denotes the parent object, and the second parameter denotes
581559
582560
Setting the predicate to `null` is equivalent to always serializing the property value.
583561
584-
For contracts originating from <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver>,
585-
the value of <xref:System.Text.Json.Serialization.JsonIgnoreAttribute.Condition> will map to this predicate.
562+
For contracts originating from <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver>, the value of <xref:System.Text.Json.Serialization.JsonIgnoreAttribute.Condition> will map to this predicate.
586563
587564
]]></format>
588565
</remarks>

0 commit comments

Comments
 (0)