Skip to content

Commit 8b5bb9f

Browse files
carlossanlopRon Petrusha
andcommitted
Document System.Text.Json.JsonElement+ObjectEnumerator (#2909)
* Document System.Text.Json.JsonElement+ObjectEnumerator * suggestions by rpetrusha Co-Authored-By: Ron Petrusha <[email protected]>
1 parent e1007c7 commit 8b5bb9f

File tree

1 file changed

+30
-16
lines changed

1 file changed

+30
-16
lines changed

xml/System.Text.Json/JsonElement+ObjectEnumerator.xml

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@
5353
<ReturnType>System.Text.Json.JsonProperty</ReturnType>
5454
</ReturnValue>
5555
<Docs>
56-
<summary>To be added.</summary>
57-
<value>To be added.</value>
56+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
57+
<value>The element in the collection at the current position of the enumerator.</value>
5858
<remarks>To be added.</remarks>
5959
</Docs>
6060
</Member>
@@ -78,7 +78,7 @@
7878
</ReturnValue>
7979
<Parameters />
8080
<Docs>
81-
<summary>To be added.</summary>
81+
<summary>Releases the resources used by this <see cref="T:System.Text.Json.JsonElement.ObjectEnumerator" /> instance.</summary>
8282
<remarks>To be added.</remarks>
8383
</Docs>
8484
</Member>
@@ -103,7 +103,9 @@
103103
<returns>An enumerator that can be used to iterate through the object.</returns>
104104
<remarks>
105105
<format><![CDATA[
106-
106+
107+
## Remarks
108+
107109
The enumerator will enumerate the properties in the order they are declared, and when an object has multiple definitions of a single property, they will all individually be returned (each in the order they appear in the content).
108110
109111
]]></format>
@@ -130,8 +132,8 @@ The enumerator will enumerate the properties in the order they are declared, and
130132
</ReturnValue>
131133
<Parameters />
132134
<Docs>
133-
<summary>To be added.</summary>
134-
<returns>To be added.</returns>
135+
<summary>Advances the enumerator to the next element of the collection.</summary>
136+
<returns><see langword="true" /> if the enumerator was successfully advanced to the next element; <see langword="false" /> if the enumerator has passed the end of the collection.</returns>
135137
<remarks>To be added.</remarks>
136138
</Docs>
137139
</Member>
@@ -155,7 +157,7 @@ The enumerator will enumerate the properties in the order they are declared, and
155157
</ReturnValue>
156158
<Parameters />
157159
<Docs>
158-
<summary>To be added.</summary>
160+
<summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
159161
<remarks>To be added.</remarks>
160162
</Docs>
161163
</Member>
@@ -178,9 +180,15 @@ The enumerator will enumerate the properties in the order they are declared, and
178180
</ReturnValue>
179181
<Parameters />
180182
<Docs>
181-
<summary>To be added.</summary>
182-
<returns>To be added.</returns>
183-
<remarks>To be added.</remarks>
183+
<summary>Returns an enumerator that iterates through a collection.</summary>
184+
<returns>An enumerator for <see cref="T:System.Text.Json.JsonProperty" /> objects that can be used to iterate through the collection.</returns>
185+
<remarks>
186+
<format type="text/markdown"><![CDATA[
187+
188+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Text.Json.JsonElement.ObjectEnumerator> instance is cast to an [IEnumerator<JsonProperty>](xref:System.Collections.Generic.IEnumerator%601) interface.
189+
190+
]]></format>
191+
</remarks>
184192
</Docs>
185193
</Member>
186194
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
@@ -202,9 +210,15 @@ The enumerator will enumerate the properties in the order they are declared, and
202210
</ReturnValue>
203211
<Parameters />
204212
<Docs>
205-
<summary>To be added.</summary>
206-
<returns>To be added.</returns>
207-
<remarks>To be added.</remarks>
213+
<summary>Returns an enumerator that iterates through a collection.</summary>
214+
<returns>An enumerator that can be used to iterate through the collection.</returns>
215+
<remarks>
216+
<format type="text/markdown"><![CDATA[
217+
218+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Text.Json.JsonElement.ObjectEnumerator> instance is cast to an <xref:System.Collections.IEnumerable> interface.
219+
220+
]]></format>
221+
</remarks>
208222
</Docs>
209223
</Member>
210224
<Member MemberName="System.Collections.IEnumerator.Current">
@@ -226,10 +240,10 @@ The enumerator will enumerate the properties in the order they are declared, and
226240
<ReturnType>System.Object</ReturnType>
227241
</ReturnValue>
228242
<Docs>
229-
<summary>To be added.</summary>
230-
<value>To be added.</value>
243+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
244+
<value>The element in the collection at the current position of the enumerator.</value>
231245
<remarks>To be added.</remarks>
232246
</Docs>
233247
</Member>
234248
</Members>
235-
</Type>
249+
</Type>

0 commit comments

Comments
 (0)