Skip to content

Commit b36bcbd

Browse files
carlossanlopahsonkhan
authored andcommitted
Document System.Text.Json.JsonElement+ArrayEnumerator (#2908)
* Document System.Text.Json.JsonElement+ArrayEnumerator * suggestions by rpetrusha Co-Authored-By: Ron Petrusha <[email protected]> * Update xml/System.Text.Json/JsonElement+ArrayEnumerator.xml Co-Authored-By: Ahson Khan <[email protected]>
1 parent 202ac20 commit b36bcbd

File tree

1 file changed

+31
-15
lines changed

1 file changed

+31
-15
lines changed

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

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@
5353
<ReturnType>System.Text.Json.JsonElement</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.ArrayEnumerator" /> instance.</summary>
8282
<remarks>To be added.</remarks>
8383
</Docs>
8484
</Member>
@@ -124,8 +124,8 @@
124124
</ReturnValue>
125125
<Parameters />
126126
<Docs>
127-
<summary>To be added.</summary>
128-
<returns>To be added.</returns>
127+
<summary>Advances the enumerator to the next element of the collection.</summary>
128+
<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>
129129
<remarks>To be added.</remarks>
130130
</Docs>
131131
</Member>
@@ -149,7 +149,7 @@
149149
</ReturnValue>
150150
<Parameters />
151151
<Docs>
152-
<summary>To be added.</summary>
152+
<summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
153153
<remarks>To be added.</remarks>
154154
</Docs>
155155
</Member>
@@ -172,9 +172,17 @@
172172
</ReturnValue>
173173
<Parameters />
174174
<Docs>
175-
<summary>To be added.</summary>
176-
<returns>To be added.</returns>
177-
<remarks>To be added.</remarks>
175+
<summary>Returns an enumerator that iterates through a collection.</summary>
176+
<returns>An enumerator for an array of <see cref="T:System.Text.Json.JsonElement" /> that can be used to iterate through the collection.</returns>
177+
<remarks>
178+
<format type="text/markdown"><![CDATA[
179+
180+
## Remarks
181+
182+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Text.Json.JsonElement.ArrayEnumerator> instance is cast to an [IEnumerable\<JsonElement>](<xref:System.Collections.Generic.IEnumerable%601) interface.
183+
184+
]]></format>
185+
</remarks>
178186
</Docs>
179187
</Member>
180188
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
@@ -196,9 +204,17 @@
196204
</ReturnValue>
197205
<Parameters />
198206
<Docs>
199-
<summary>To be added.</summary>
200-
<returns>To be added.</returns>
201-
<remarks>To be added.</remarks>
207+
<summary>Returns an enumerator that iterates through a collection.</summary>
208+
<returns>An enumerator that can be used to iterate through the collection.</returns>
209+
<remarks>
210+
<format type="text/markdown"><![CDATA[
211+
212+
## Remarks
213+
214+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Text.Json.JsonElement.ArrayEnumerator> instance is cast to an <xref:System.Collections.IEnumerable> interface.
215+
216+
]]></format>
217+
</remarks>
202218
</Docs>
203219
</Member>
204220
<Member MemberName="System.Collections.IEnumerator.Current">
@@ -220,10 +236,10 @@
220236
<ReturnType>System.Object</ReturnType>
221237
</ReturnValue>
222238
<Docs>
223-
<summary>To be added.</summary>
224-
<value>To be added.</value>
239+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
240+
<value>The element in the collection at the current position of the enumerator.</value>
225241
<remarks>To be added.</remarks>
226242
</Docs>
227243
</Member>
228244
</Members>
229-
</Type>
245+
</Type>

0 commit comments

Comments
 (0)