Skip to content

Document System.IO.StringReader #3619

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

Merged
merged 2 commits into from
Dec 4, 2019
Merged

Document System.IO.StringReader #3619

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
105a19f
Document System.IO.StringReader
carlossanlop Dec 3, 2019
0efb6aa
suggestions by gewarren
carlossanlop Dec 3, 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
51 changes: 35 additions & 16 deletions xml/System.IO/StringReader.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,10 +461,11 @@ This implementation of `Close` calls the <xref:System.IO.StringReader.Dispose%2A
<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" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<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>
<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>
<returns>The total number of characters read into the buffer.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">The current string reader instance is closed.</exception>
</Docs>
</Member>
<Member MemberName="Read">
Expand Down Expand Up @@ -577,10 +578,10 @@ This implementation of `Close` calls the <xref:System.IO.StringReader.Dispose%2A
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="buffer">When this method returns, contains the characters read from the current source.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<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>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -686,10 +687,19 @@ This implementation of `Close` calls the <xref:System.IO.StringReader.Dispose%2A
<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" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<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>
<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>
<returns>The total number of characters read into the buffer.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

<xref:System.IO.StringReader.ReadBlock(System.Span{System.Char})> internally calls <xref:System.IO.StringReader.Read(System.Span{System.Char})> directly.

]]></format>
</remarks>
<exception cref="T:System.ObjectDisposedException">The current string reader instance is closed.</exception>
</Docs>
</Member>
<Member MemberName="ReadBlockAsync">
Expand Down Expand Up @@ -720,11 +730,20 @@ This implementation of `Close` calls the <xref:System.IO.StringReader.Dispose%2A
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<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>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<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>
<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>
<remarks>
<format type="text/markdown">
<![CDATA[

## Remarks

<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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ReadBlockAsync">
Expand Down