Skip to content

Commit cc0baa0

Browse files
carlossanlopRon Petrusha
authored andcommitted
Automatically port System.Text.Json.JsonProperty (#2881)
* Automatically port System.Text.Json.JsonProperty * suggestions by Jozkee Co-Authored-By: David Cantu <[email protected]> * Update JsonProperty.xml
1 parent 6db0580 commit cc0baa0

File tree

1 file changed

+44
-17
lines changed

1 file changed

+44
-17
lines changed

xml/System.Text.Json/JsonProperty.xml

Lines changed: 44 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@
3939
<ReturnType>System.String</ReturnType>
4040
</ReturnValue>
4141
<Docs>
42-
<summary>The name of this property.</summary>
43-
<value>To be added.</value>
42+
<summary>Gets the name of this property.</summary>
43+
<value>The name of this property.</value>
4444
<remarks>To be added.</remarks>
4545
</Docs>
4646
</Member>
@@ -63,10 +63,19 @@
6363
<Parameter Name="utf8Text" Type="System.ReadOnlySpan&lt;System.Byte&gt;" />
6464
</Parameters>
6565
<Docs>
66-
<param name="utf8Text">To be added.</param>
67-
<summary>To be added.</summary>
68-
<returns>To be added.</returns>
69-
<remarks>To be added.</remarks>
66+
<param name="utf8Text">The UTF-8 encoded text to compare against.</param>
67+
<summary>Compares the specified UTF-8 encoded text to the name of this property.</summary>
68+
<returns><see langword="true" /> if the name of this property has the same UTF-8 encoding as <paramref name="utf8Text" />; otherwise, <see langword="false" />.</returns>
69+
<remarks>
70+
<format type="text/markdown"><![CDATA[
71+
72+
## Remarks
73+
74+
This method is functionally equal to doing an ordinal comparison of `utf8Text` and <xref:System.Text.Json.JsonProperty.Name>, but it can avoid creating the string instance.
75+
76+
]]></format>
77+
</remarks>
78+
<exception cref="T:System.InvalidOperationException">This value's <see cref="T:System.Type" /> is not <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />.</exception>
7079
</Docs>
7180
</Member>
7281
<Member MemberName="NameEquals">
@@ -88,10 +97,19 @@
8897
<Parameter Name="text" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
8998
</Parameters>
9099
<Docs>
91-
<param name="text">To be added.</param>
92-
<summary>To be added.</summary>
93-
<returns>To be added.</returns>
94-
<remarks>To be added.</remarks>
100+
<param name="text">The text to compare against.</param>
101+
<summary>Compares the specified text as a character span to the name of this property.</summary>
102+
<returns><see langword="true" /> if the name of this property matches <paramref name="text" />; otherwise, <see langword="false" />.</returns>
103+
<remarks>
104+
<format type="text/markdown"><![CDATA[
105+
106+
## Remarks
107+
108+
This method is functionally equal to doing an ordinal comparison of `text` and <xref:System.Text.Json.JsonProperty.Name>, but it can avoid creating the string instance.
109+
110+
]]></format>
111+
</remarks>
112+
<exception cref="T:System.InvalidOperationException">This value's <see cref="T:System.Type" /> is not <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />.</exception>
95113
</Docs>
96114
</Member>
97115
<Member MemberName="NameEquals">
@@ -113,10 +131,19 @@
113131
<Parameter Name="text" Type="System.String" />
114132
</Parameters>
115133
<Docs>
116-
<param name="text">To be added.</param>
117-
<summary>To be added.</summary>
118-
<returns>To be added.</returns>
119-
<remarks>To be added.</remarks>
134+
<param name="text">The text to compare against.</param>
135+
<summary>Compares the specified string to the name of this property.</summary>
136+
<returns><see langword="true" /> if the name of this property matches <paramref name="text" />; otherwise <see langword="false" />.</returns>
137+
<remarks>
138+
<format type="text/markdown"><![CDATA[
139+
140+
## Remarks
141+
142+
This method is functionally equal to doing an ordinal comparison of `text` and <xref:System.Text.Json.JsonProperty.Name>.
143+
144+
]]></format>
145+
</remarks>
146+
<exception cref="T:System.InvalidOperationException">This value's <see cref="T:System.Type" /> is not <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />.</exception>
120147
</Docs>
121148
</Member>
122149
<Member MemberName="ToString">
@@ -157,10 +184,10 @@
157184
<ReturnType>System.Text.Json.JsonElement</ReturnType>
158185
</ReturnValue>
159186
<Docs>
160-
<summary>The value of this property.</summary>
161-
<value>To be added.</value>
187+
<summary>Gets the value of this property.</summary>
188+
<value>The value of this property.</value>
162189
<remarks>To be added.</remarks>
163190
</Docs>
164191
</Member>
165192
</Members>
166-
</Type>
193+
</Type>

0 commit comments

Comments
 (0)