From: RJ <reid@wilden.haus>
Date: Wed, 22 May 2019 02:49:49 +0000 (-0400)
Subject: Fix ambiguous Utf8JsonReader Get/TryGet method documentation (dotnet/corefx#37779)
X-Git-Tag: submit/tizen/20210909.063632~11031^2~1521
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=07d6ab796e7b02ff3d299d3efd70d912147a3565;p=platform%2Fupstream%2Fdotnet%2Fruntime.git

Fix ambiguous Utf8JsonReader Get/TryGet method documentation (dotnet/corefx#37779)



Commit migrated from https://github.com/dotnet/corefx/commit/2016619a120bcf6c690801bc577b2e170f1a92e1
---

diff --git a/src/libraries/System.Text.Json/src/System/Text/Json/Reader/Utf8JsonReader.TryGet.cs b/src/libraries/System.Text.Json/src/System/Text/Json/Reader/Utf8JsonReader.TryGet.cs
index 201d6f9..d4e25a7 100644
--- a/src/libraries/System.Text.Json/src/System/Text/Json/Reader/Utf8JsonReader.TryGet.cs
+++ b/src/libraries/System.Text.Json/src/System/Text/Json/Reader/Utf8JsonReader.TryGet.cs
@@ -11,7 +11,7 @@ namespace System.Text.Json
     public ref partial struct Utf8JsonReader
     {
         /// <summary>
-        /// Reads the next JSON token value from the source, unescaped, and transcoded as a <see cref="string"/>.
+        /// Parses the current JSON token value from the source, unescaped, and transcoded as a <see cref="string"/>.
         /// </summary>
         /// <exception cref="InvalidOperationException">
         /// Thrown if trying to get the value of the JSON token that is not a string
@@ -40,7 +40,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source as a comment, transcoded as a <see cref="string"/>.
+        /// Parses the current JSON token value from the source as a comment, transcoded as a <see cref="string"/>.
         /// </summary>
         /// <exception cref="InvalidOperationException">
         /// Thrown if trying to get the value of the JSON token that is not a comment.
@@ -57,7 +57,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source as a <see cref="bool"/>.
+        /// Parses the current JSON token value from the source as a <see cref="bool"/>.
         /// Returns true if the TokenType is JsonTokenType.True and false if the TokenType is JsonTokenType.False.
         /// </summary>
         /// <exception cref="InvalidOperationException">
@@ -85,7 +85,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to an <see cref="int"/>.
+        /// Parses the current JSON token value from the source as an <see cref="int"/>.
         /// Returns the value if the entire UTF-8 encoded token value can be successfully parsed to an <see cref="int"/>
         /// value.
         /// Throws exceptions otherwise.
@@ -109,7 +109,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="long"/>.
+        /// Parses the current JSON token value from the source as a <see cref="long"/>.
         /// Returns the value if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="long"/>
         /// value.
         /// Throws exceptions otherwise.
@@ -133,7 +133,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="uint"/>.
+        /// Parses the current JSON token value from the source as a <see cref="uint"/>.
         /// Returns the value if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="uint"/>
         /// value.
         /// Throws exceptions otherwise.
@@ -158,7 +158,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="ulong"/>.
+        /// Parses the current JSON token value from the source as a <see cref="ulong"/>.
         /// Returns the value if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="ulong"/>
         /// value.
         /// Throws exceptions otherwise.
@@ -183,7 +183,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="float"/>.
+        /// Parses the current JSON token value from the source as a <see cref="float"/>.
         /// Returns the value if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="float"/>
         /// value.
         /// Throws exceptions otherwise.
@@ -206,7 +206,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="double"/>.
+        /// Parses the current JSON token value from the source as a <see cref="double"/>.
         /// Returns the value if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="double"/>
         /// value.
         /// Throws exceptions otherwise.
@@ -229,7 +229,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="decimal"/>.
+        /// Parses the current JSON token value from the source as a <see cref="decimal"/>.
         /// Returns the value if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="decimal"/>
         /// value.
         /// Throws exceptions otherwise.
@@ -252,7 +252,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="DateTime"/>.
+        /// Parses the current JSON token value from the source as a <see cref="DateTime"/>.
         /// Returns the value if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="DateTime"/>
         /// value.
         /// Throws exceptions otherwise.
@@ -275,7 +275,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="DateTimeOffset"/>.
+        /// Parses the current JSON token value from the source as a <see cref="DateTimeOffset"/>.
         /// Returns the value if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="DateTimeOffset"/>
         /// value.
         /// Throws exceptions otherwise.
@@ -298,7 +298,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="Guid"/>.
+        /// Parses the current JSON token value from the source as a <see cref="Guid"/>.
         /// Returns the value if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="Guid"/>
         /// value.
         /// Throws exceptions otherwise.
@@ -321,7 +321,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to an <see cref="int"/>.
+        /// Parses the current JSON token value from the source as an <see cref="int"/>.
         /// Returns true if the entire UTF-8 encoded token value can be successfully 
         /// parsed to an <see cref="int"/> value.
         /// Returns false otherwise.
@@ -342,7 +342,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="long"/>.
+        /// Parses the current JSON token value from the source as a <see cref="long"/>.
         /// Returns true if the entire UTF-8 encoded token value can be successfully 
         /// parsed to a <see cref="long"/> value.
         /// Returns false otherwise.
@@ -363,7 +363,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="uint"/>.
+        /// Parses the current JSON token value from the source as a <see cref="uint"/>.
         /// Returns true if the entire UTF-8 encoded token value can be successfully 
         /// parsed to a <see cref="uint"/> value.
         /// Returns false otherwise.
@@ -385,7 +385,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="ulong"/>.
+        /// Parses the current JSON token value from the source as a <see cref="ulong"/>.
         /// Returns true if the entire UTF-8 encoded token value can be successfully 
         /// parsed to a <see cref="ulong"/> value.
         /// Returns false otherwise.
@@ -407,7 +407,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="float"/>.
+        /// Parses the current JSON token value from the source as a <see cref="float"/>.
         /// Returns true if the entire UTF-8 encoded token value can be successfully 
         /// parsed to a <see cref="float"/> value.
         /// Returns false otherwise.
@@ -428,7 +428,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="double"/>.
+        /// Parses the current JSON token value from the source as a <see cref="double"/>.
         /// Returns true if the entire UTF-8 encoded token value can be successfully 
         /// parsed to a <see cref="double"/> value.
         /// Returns false otherwise.
@@ -449,7 +449,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="decimal"/>.
+        /// Parses the current JSON token value from the source as a <see cref="decimal"/>.
         /// Returns true if the entire UTF-8 encoded token value can be successfully 
         /// parsed to a <see cref="decimal"/> value.
         /// Returns false otherwise.
@@ -470,7 +470,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="DateTime"/>.
+        /// Parses the current JSON token value from the source as a <see cref="DateTime"/>.
         /// Returns true if the entire UTF-8 encoded token value can be successfully
         /// parsed to a <see cref="DateTime"/> value.
         /// Returns false otherwise.
@@ -529,7 +529,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="DateTimeOffset"/>.
+        /// Parses the current JSON token value from the source as a <see cref="DateTimeOffset"/>.
         /// Returns true if the entire UTF-8 encoded token value can be successfully
         /// parsed to a <see cref="DateTimeOffset"/> value.
         /// Returns false otherwise.
@@ -588,7 +588,7 @@ namespace System.Text.Json
         }
 
         /// <summary>
-        /// Reads the next JSON token value from the source and parses it to a <see cref="Guid"/>.
+        /// Parses the current JSON token value from the source as a <see cref="Guid"/>.
         /// Returns <see langword="true"/> if the entire UTF-8 encoded token value can be successfully
         /// parsed to a <see cref="Guid"/> value. Only supports <see cref="Guid"/> values with hyphens
         /// and without any surrounding decorations.