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 1 commit
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
Prev Previous commit
Next Next commit
Apply suggestions from code review 
Removing extra spaces, thanks ahsonkhan.

Co-Authored-By: carlossanlop <[email protected]>
  • Loading branch information
@carlossanlop
carlossanlop authored Apr 25, 2019
commit 278fb4eb51b0e336f4a774760ba3ac0ba0ee3669
6 changes: 3 additions & 3 deletions xml/System.Text.Json/JsonDocument.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@
<Docs>
<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>
<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>
Expand Down Expand Up @@ -208,7 +208,7 @@
<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>
<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>
Expand Down Expand Up @@ -237,4 +237,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>
6 changes: 3 additions & 3 deletions xml/System.Text.Json/JsonElement.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -680,7 +680,7 @@
<summary>Looks for a property named <paramref name="propertyName" /> in the current object, returning whether or not such a property existed. When the property exists <paramref name="value" /> is assigned to the value of that property.</summary>
<returns><see langword="true" /> if the property was found, <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException"> This value's <see cref="P:System.Text.Json.JsonElement.Type" /> is not <see cref="F:System.Text.Json.JsonValueType.Object" />.</exception>
<exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.Type" /> is not <see cref="F:System.Text.Json.JsonValueType.Object" />.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="propertyName" /> is <see langword="null" />.</exception>
<exception cref="T:System.ObjectDisposedException"> The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
</Docs>
Expand Down Expand Up @@ -708,7 +708,7 @@
<summary>Attempts to represent the current JSON number as a <see cref="T:System.Single" />.</summary>
<returns><see langword="true" /> if the number can be represented as a <see cref="T:System.Single" />, <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException"> This value's <see cref="P:System.Text.Json.JsonElement.Type" /> is not <see cref="F:System.Text.Json.JsonValueType.Number" />.</exception>
<exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.Type" /> is not <see cref="F:System.Text.Json.JsonValueType.Number" />.</exception>
<exception cref="T:System.ObjectDisposedException"> The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -799,4 +799,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>