Skip to content

Document System.Text.Json.JsonElement+ObjectEnumerator #2909

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 5, 2019
Merged

Document System.Text.Json.JsonElement+ObjectEnumerator #2909

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7c5169
Document System.Text.Json.JsonElement+ObjectEnumerator
carlossanlop Aug 1, 2019
112694c
suggestions by rpetrusha
carlossanlop Aug 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 30 additions & 16 deletions xml/System.Text.Json/JsonElement+ObjectEnumerator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@
<ReturnType>System.Text.Json.JsonProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
<value>The element in the collection at the current position of the enumerator.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -78,7 +78,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Releases the resources used by this <see cref="T:System.Text.Json.JsonElement.ObjectEnumerator" /> instance.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -103,7 +103,9 @@
<returns>An enumerator that can be used to iterate through the object.</returns>
<remarks>
<format><![CDATA[


## Remarks

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).

]]></format>
Expand All @@ -130,8 +132,8 @@ The enumerator will enumerate the properties in the order they are declared, and
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Advances the enumerator to the next element of the collection.</summary>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -155,7 +157,7 @@ The enumerator will enumerate the properties in the order they are declared, and
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -178,9 +180,15 @@ The enumerator will enumerate the properties in the order they are declared, and
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Returns an enumerator that iterates through a collection.</summary>
<returns>An enumerator for <see cref="T:System.Text.Json.JsonProperty" /> objects that can be used to iterate through the collection.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
Expand All @@ -202,9 +210,15 @@ The enumerator will enumerate the properties in the order they are declared, and
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Returns an enumerator that iterates through a collection.</summary>
<returns>An enumerator that can be used to iterate through the collection.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerator.Current">
Expand All @@ -226,10 +240,10 @@ The enumerator will enumerate the properties in the order they are declared, and
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
<value>The element in the collection at the current position of the enumerator.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>