8000 Document System.IO.StringReader (#3619) · CAndRyan/dotnet-api-docs@973479a · GitHub
[go: up one dir, main page]
Skip to content

Commit 973479a

Browse files
carlossanlopgewarren
carlossanlop
and
gewarren
authored
Document System.IO.StringReader (dotnet#3619)
* Document System.IO.StringReader * suggestions by gewarren Co-Authored-By: Genevieve Warren <gewarren@microsoft.com>
1 parent be3b84e commit 973479a

File tree

1 file changed

+35
-16
lines changed

1 file changed

+35
-16
lines changed

‎xml/System.IO/StringReader.xml

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -461,10 +461,11 @@ This implementation of `Close` calls the <xref:System.IO.StringReader.Dispose%2A
461461
<Parameter Name="buffer" Type="System.Span&lt;System.Char&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
462462
</Parameters>
463463
<Docs>
464-
<param name="buffer">To be added.</param>
465-
<summary>To be added.</summary>
466-
<returns>To be added.</returns>
464+
<param name="buffer">When this method returns, contains the characters read from the current source. If the total number of characters read is zero, the span remains unmodified.</param>
465+
<summary>Reads all the characters from the input string, starting at the current position, and advances the current position to the end of the input string.</summary>
466+
<returns>The total number of characters read into the buffer.</returns>
467467
<remarks>To be added.</remarks>
468+
<exception cref="T:System.ObjectDisposedException">The current string reader instance is closed.</exception>
468469
</Docs>
469470
</Member>
470471
<Member MemberName="Read">
@@ -577,10 +578,10 @@ This implementation of `Close` calls the <xref:System.IO.StringReader.Dispose%2A
577578
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
578579
</Parameters>
579580
<Docs>
580-
<param name="buffer">To be added.</param>
581-
<param name="cancellationToken">To be added.</param>
582-
<summary>To be added.</summary>
583-
<returns>To be added.</returns>
581+
<param name="buffer">When this method returns, contains the characters read from the current source.</param>
582+
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
583+
<summary>Asynchronously reads all the characters from the input string, starting at the current position, and advances the current position to the end of the input string.</summary>
584+
<returns>A task that represents the asynchronous read operation. The value of the <paramref name="TResult" /> parameter contains the total number of characters read into the buffer.</returns>
584585
<remarks>To be added.</remarks>
585586
</Docs>
586587
</Member>
@@ -686,10 +687,19 @@ This implementation of `Close` calls the <xref:System.IO.StringReader.Dispose%2A
686687
<Parameter Name="buffer" Type="System.Span&lt;System.Char&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
687688
</Parameters>
688689
<Docs>
689-
<param name="buffer">To be added.</param>
690-
<summary>To be added.</summary>
691-
<returns>To be added.</returns>
692-
<remarks>To be added.</remarks>
690+
<param name="buffer">When this method returns, contains the characters read from the current source. If the total number of characters read is zero, the span remains unmodified.</param>
691+
<summary>Reads all the characters from the input string starting at the current position and advances the current position to the end of the input string.</summary>
692+
<returns>The total number of characters read into the buffer.</returns>
693+
<remarks>
694+
<format type="text/markdown"><![CDATA[
695+
696+
## Remarks
697+
698+
<xref:System.IO.StringReader.ReadBlock(System.Span{System.Char})> internally calls <xref:System.IO.StringReader.Read(System.Span{System.Char})> directly.
699+
700+
]]></format>
701+
</remarks>
702+
<exception cref="T:System.ObjectDisposedException">The current string reader instance is closed.</exception>
693703
</Docs>
694704
</Member>
695705
<Member MemberName="ReadBlockAsync">
@@ -720,11 +730,20 @@ This implementation of `Close` calls the <xref:System.IO.StringReader.Dispose%2A
720730
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
721731
</Parameters>
722732
<Docs>
723-
<param name="buffer">To be added.</param>
724-
<param name="cancellationToken">To be added.</param>
725-
<summary>To be added.</summary>
726-
<returns>To be added.</returns>
727-
<remarks>To be added.</remarks>
733+
<param name="buffer">When this method returns, contains the characters read from the current source. If the total number of characters read is zero, the span remains unmodified.</param>
734+
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
735+
<summary>Asynchronously reads all the characters from the input string starting at the current position and advances the current position to the end of the input string.</summary>
736+
<returns>A task representing the asynchronous read operation. The value of the <paramref name="TResult" /> parameter contains the total number of characters read into the buffer.</returns>
737+
<remarks>
738+
<format type="text/markdown">
739+
<![CDATA[
740+
741+
## Remarks
742+
743+
<xref:System.IO.StringReader.ReadBlockAsync(System.Memory{System.Char},System.Threading.CancellationToken)> calls <xref:System.IO.StringReader.ReadBlock(System.Span{System.Char})> asynchronously, which in turn calls <xref:System.IO.StringReader.Read(System.Span{System.Char})> directly.
744+
745+
]]></format>
746+
</remarks>
728747
</Docs>
729748
</Member>
730749
<Member MemberName="ReadBlockAsync">

0 commit comments

Comments
 (0)
0