Skip to content

Commit

Permalink
Fix typo and para tags
Browse files Browse the repository at this point in the history
  • Loading branch information
@gewarren
gewarren authored Oct 17, 2024
1 parent ada2cc1 commit 62c853f
Showing 1 changed file with 16 additions and 39 deletions.
55 changes: 16 additions & 39 deletions xml/System.Text.Json.Serialization.Metadata/JsonPropertyInfo.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,8 @@
<summary>Gets the constructor parameter associated with the current property.</summary>
<value>To be added.</value>
<remarks>
<para>Returns the <see cref="T:System.Text.Json.Serialization.Metadata.JsonParameterInfo" /> metadata for the parameter in the</para>
<para>deserialization constructor that has been associated with the current property.</para>
<para>A constructor parameter is matched to a property or field if they are of the</para>
<para>same type and have the same name, up to case insensitivity. Each constructor</para>
<para>parameter must be matched to exactly one property of field.</para>
<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>
<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 constructo parameter must be matched to exactly one property or field.</para>
</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -94,11 +91,9 @@
## Remarks
When resolving metadata via <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver>, this property
will be populated with the underlying <xref:System.Reflection.MemberInfo> of the serialized property or field.
When resolving metadata via <xref:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver>, this property will be populated with the underlying <xref:System.Reflection.MemberInfo> of the serialized property or field.
Setting a custom attribute provider has no impact on the contract model
but serves as metadata for downstream contract modifiers.
Setting a custom attribute provider has no impact on the contract model but serves as metadata for downstream contract modifiers.
]]></format>
</remarks>
Expand Down Expand Up @@ -135,10 +130,9 @@ Setting a custom attribute provider has no impact on the contract model
## Remarks
It is possible to use <xref:System.Text.Json.Serialization.JsonConverterFactory> instances with this property.
It's possible to use <xref:System.Text.Json.Serialization.JsonConverterFactory> instances with this property.
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.
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.
]]></format>
</remarks>
Expand Down Expand Up @@ -225,10 +219,7 @@ Setting to `null` will result in the property being skipped on serialization.
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
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.
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.
]]></format>
</remarks>
Expand Down Expand Up @@ -258,11 +249,8 @@ The current <see cref="P:System.Text.Json.Serialization.Metadata.JsonPropertyInf
<summary>Gets or sets a value indicating whether the return type of the getter is annotated as nullable.</summary>
<value>To be added.</value>
<remarks>
<para>Contracts originating from <see cref="T:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver" /> or <see cref="T:System.Text.Json.Serialization.JsonSerializerContext" />,</para>
<para>derive the value of this property from nullable reference type annotations, including annotations</para>
<para>from attributes such as <see cref="T:System.Diagnostics.CodeAnalysis.NotNullAttribute" /> or <see cref="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute" />.</para>
<para>This property has no effect on serialization unless the <see cref="P:System.Text.Json.JsonSerializerOptions.RespectNullableAnnotations" /></para>
<para>property has been enabled, in which case the serializer will reject any <see langword="null" /> values returned by the getter.</para>
<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>
<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>
</remarks>
<exception cref="T:System.InvalidOperationException">
<para>The <see cref="T:System.Text.Json.Serialization.Metadata.JsonPropertyInfo" /> instance has been locked for further modification.</para>
Expand Down Expand Up @@ -326,13 +314,9 @@ The `required` keyword is currently not supported in <xref:System.Text.Json.Seri
<summary>Gets or sets a value indicating whether the input type of the setter is annotated as nullable.</summary>
<value>To be added.</value>
<remarks>
<para>Contracts originating from <see cref="T:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver" /> or <see cref="T:System.Text.Json.Serialization.JsonSerializerContext" />,</para>
<para>derive the value of this property from nullable reference type annotations, including annotations</para>
<para>from attributes such as <see cref="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute" /> or <see cref="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute" />.</para>
<para>This property has no effect on deserialization unless the <see cref="P:System.Text.Json.JsonSerializerOptions.RespectNullableAnnotations" /></para>
<para>property has been enabled, in which case the serializer will reject any <see langword="null" /> deserialization results.</para>
<para>If the property has been associated with a deserialization constructor parameter,</para>
<para>this setting reflected the nullability annotation of the parameter and not the property setter.</para>
<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>
<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>
<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>
</remarks>
<exception cref="T:System.InvalidOperationException">
<para>The <see cref="T:System.Text.Json.Serialization.Metadata.JsonPropertyInfo" /> instance has been locked for further modification.</para>
Expand Down Expand Up @@ -367,9 +351,7 @@ The `required` keyword is currently not supported in <xref:System.Text.Json.Seri
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>.
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>.
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>.
]]></format>
</remarks>
Expand Down Expand Up @@ -400,10 +382,7 @@ For contracts originating from <xref:System.Text.Json.Serialization.Metadata.Def
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
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.
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.
]]></format>
</remarks>
Expand Down Expand Up @@ -480,8 +459,7 @@ For contracts originating from <xref:System.Text.Json.Serialization.Metadata.Def
## Remarks
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.
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.
]]></format>
</remarks>
Expand Down Expand Up @@ -581,8 +559,7 @@ The first parameter denotes the parent object, and the second parameter denotes
Setting the predicate to `null` is equivalent to always serializing the property value.
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.
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.
]]></format>
</remarks>
Expand Down

0 comments on commit 62c853f

Please sign in to comment.