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 2 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
66 changes: 39 additions & 27 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,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 text to parse.</param>
<param name="readerOptions">Options to control the reader behavior during parsing.</param>
<summary>Parse a sequence as UTF-8-encoded text representing a single JSON value into a 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="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 +93,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>Parse a <see cref="T:System.IO.Stream" /> as UTF-8-encoded data representing a single JSON value into a 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 +121,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 text to parse.</param>
<param name="readerOptions">Options to control the reader behavior during parsing.</param>
<summary>Parse memory as UTF-8-encoded text representing a single JSON value into a 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="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 +149,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>Parse text representing a single JSON value into a 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="Parse">
Expand All @@ -169,11 +177,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>Parse text representing a single JSON value into a 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 +205,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>Parse a <see cref="T:System.IO.Stream" /> as UTF-8-encoded data representing a single JSON value into a JsonDocument. The Stream will be read to completion.</summary>
<returns>A Task to produce 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="RootElement">
Expand All @@ -219,10 +231,10 @@
<ReturnType>System.Text.Json.JsonElement</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>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>
4 changes: 2 additions & 2 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 <see cref="T:System.Text.Json.JsonElement.ArrayEnumerator" /> value that can be used to iterate through the array.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
4 changes: 2 additions & 2 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,8 +99,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns an enumerator that iterates the properties of an object.</summary>
<returns>An <see cref="T:System.Text.Json.JsonElement.ObjectEnumerator" /> value that can be used to iterate through the object.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
Loading