Skip to content

Port System.Text.Json source comments to Docs #2360

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

Closed
wants to merge 8 commits into from
Closed

Port System.Text.Json source comments to Docs #2360

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f7e0281
Port System.Text.Json source comments to Docs
carlossanlop Apr 24, 2019
278fb4e
Apply suggestions from code review
carlossanlop Apr 25, 2019
de476f8
Adding missing remarks and some more exceptions.
carlossanlop Apr 25, 2019
a3f5ee4
Adding missing remarks and some more exceptions.
carlossanlop Apr 25, 2019
2d2075f
Update JsonElement.xml
carlossanlop Apr 25, 2019
5517bd6
Update Utf8JsonWriter.xml
carlossanlop Apr 26, 2019
12b1158
Apply suggestions from code review
May 7, 2019
1068a9b
Apply suggestions from code review
carlossanlop May 7, 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
76 changes: 46 additions & 30 deletions xml/System.Text.Json/JsonDocument.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,15 @@
<Parameter Name="readerOptions" Type="System.Text.Json.JsonReaderOptions" />
</Parameters>
<Docs>
<param name="utf8Json">To be added.</param>
<param name="readerOptions">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="utf8Json">The JSON text to parse.</param>
<param name="readerOptions">Options to control the reader behavior during parsing.</param>
<summary>Parses a sequence as UTF-8-encoded text representing a single JSON value into a <see cref="T:System.Text.Json.JsonDocument" />.</summary>
<returns>A JsonDocument representation of the JSON value.</returns>
<remarks>The <see cref="T:System.Buffers.ReadOnlySequence`1" /> may be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object's lifetime.

Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must not be present.</remarks>
<exception cref="T:System.Text.Json.JsonReaderException"><paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
<exception cref="T:System.ArgumentException"><paramref name="readerOptions" /> contains unsupported options.</exception>
</Docs>
</Member>
<Member MemberName="Parse">
Expand All @@ -91,11 +95,13 @@
<Parameter Name="readerOptions" Type="System.Text.Json.JsonReaderOptions" />
</Parameters>
<Docs>
<param name="utf8Json">To be added.</param>
<param name="readerOptions">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="utf8Json">JSON data to parse.</param>
<param name="readerOptions">Options to control the reader behavior during parsing.</param>
<summary>Parses a <see cref="T:System.IO.Stream" /> as UTF-8-encoded data representing a single JSON value into a <see cref="T:System.Text.Json.JsonDocument" />. The stream will be read to completion.</summary>
<returns>A JsonDocument representation of the JSON value.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Text.Json.JsonReaderException"><paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
<exception cref="T:System.ArgumentException"><paramref name="readerOptions" /> contains unsupported options.</exception>
</Docs>
</Member>
<Member MemberName="Parse">
Expand All @@ -117,11 +123,15 @@
<Parameter Name="readerOptions" Type="System.Text.Json.JsonReaderOptions" />
</Parameters>
<Docs>
<param name="utf8Json">To be added.</param>
<param name="readerOptions">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="utf8Json">JSON text to parse.</param>
<param name="readerOptions">Options to control the reader behavior during parsing.</param>
<summary>Parses memory as UTF-8-encoded text representing a single JSON value into a <see cref="T:System.Text.Json.JsonDocument" />.</summary>
<returns>A JsonDocument representation of the JSON value.</returns>
<remarks>The <see cref="T:System.ReadOnlyMemory`1" /> value will be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object's lifetime.

Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must not be present.</remarks>
<exception cref="T:System.Text.Json.JsonReaderException"><paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
<exception cref="T:System.ArgumentException"><paramref name="readerOptions" /> contains unsupported options.</exception>
</Docs>
</Member>
<Member MemberName="Parse">
Expand All @@ -143,11 +153,13 @@
<Parameter Name="readerOptions" Type="System.Text.Json.JsonReaderOptions" />
</Parameters>
<Docs>
<param name="json">To be added.</param>
<param name="readerOptions">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="json">The JSON text to parse.</param>
<param name="readerOptions">Options to control the reader behavior during parsing.</param>
<summary>Parses text representing a single JSON value into a <see cref="T:System.Text.Json.JsonDocument" />.</summary>
<returns>A JsonDocument representation of the JSON value.</returns>
<remarks>The <see cref="T:System.ReadOnlyMemory`1" /> value may be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object's lifetime.</remarks>
<exception cref="T:System.Text.Json.JsonReaderException"><paramref name="json" /> does not represent a valid single JSON value.</exception>
<exception cref="T:System.ArgumentException"><paramref name="readerOptions" /> contains unsupported options.</exception>
</Docs>
</Member>
<Member MemberName="Parse">
Expand All @@ -169,11 +181,13 @@
<Parameter Name="readerOptions" Type="System.Text.Json.JsonReaderOptions" />
</Parameters>
<Docs>
<param name="json">To be added.</param>
<param name="readerOptions">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="json">JSON text to parse.</param>
<param name="readerOptions">Options to control the reader behavior during parsing.</param>
<summary>Parses text representing a single JSON value into a <see cref="T:System.Text.Json.JsonDocument" />.</summary>
<returns>A JsonDocument representation of the JSON value.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Text.Json.JsonReaderException"><paramref name="json" /> does not represent a valid single JSON value.</exception>
<exception cref="T:System.ArgumentException"><paramref name="readerOptions" /> contains unsupported options.</exception>
</Docs>
</Member>
<Member MemberName="ParseAsync">
Expand All @@ -195,12 +209,14 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="utf8Json">To be added.</param>
<param name="readerOptions">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="utf8Json">JSON data to parse.</param>
<param name="readerOptions">Options to control the reader behavior during parsing.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>Parses a <see cref="T:System.IO.Stream" /> as UTF-8-encoded data representing a single JSON value into a <see cref="T:System.Text.Json.JsonDocument" />. The stream will be read to completion.</summary>
<returns>A task to produce a <see cref="T:System.Text.Json.JsonDocument" /> representation of the JSON value.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Text.Json.JsonReaderException"><paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
<exception cref="T:System.ArgumentException"><paramref name="readerOptions" /> contains unsupported options.</exception>
</Docs>
</Member>
<Member MemberName="RootElement">
Expand All @@ -219,10 +235,10 @@
<ReturnType>System.Text.Json.JsonElement</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="T:System.Text.Json.JsonElement" /> representing the value of the document.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>
6 changes: 3 additions & 3 deletions xml/System.Text.Json/JsonElement+ArrayEnumerator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns an enumerator that iterates through a collection.</summary>
<returns>An enumerator that can be used to iterate through the array.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -226,4 +226,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>
8 changes: 4 additions & 4 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 @@ -99,9 +99,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Returns an enumerator that iterates the properties of an object.</summary>
<returns>An enumerator that can be used to iterate through the object.</returns>
<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).</remarks>
</Docs>
</Member>
<Member MemberName="MoveNext">
Expand Down Expand Up @@ -226,4 +226,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>
Loading