Skip to content

Commit b4a4043

Browse files
carlossanlopRon Petrusha
andcommitted
Manually document System.IO.BinaryWriter, StreamWriter, StringWriter, TextWriter (#2774)
* Manually document System.IO.StreamWriter and TextWriter * Added BinaryWriter and StringWriter documentation * suggestions by rpetrusha Co-Authored-By: Ron Petrusha <[email protected]>
1 parent e10f13f commit b4a4043

File tree

4 files changed

+447
-275
lines changed

4 files changed

+447
-275
lines changed

xml/System.IO/BinaryWriter.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -546,8 +546,8 @@
546546
</ReturnValue>
547547
<Parameters />
548548
<Docs>
549-
<summary>To be added.</summary>
550-
<returns>To be added.</returns>
549+
<summary>Asynchronously releases all resources used by the current instance of the <see cref="T:System.IO.BinaryWriter" /> class.</summary>
550+
<returns>A task that represents the asynchronous dispose operation.</returns>
551551
<remarks>To be added.</remarks>
552552
</Docs>
553553
</Member>
@@ -1543,8 +1543,8 @@
15431543
<Parameter Name="buffer" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
15441544
</Parameters>
15451545
<Docs>
1546-
<param name="buffer">To be added.</param>
1547-
<summary>To be added.</summary>
1546+
<param name="buffer">The span of bytes to write.</param>
1547+
<summary>Writes a span of bytes to the current stream.</summary>
15481548
<remarks>To be added.</remarks>
15491549
</Docs>
15501550
</Member>
@@ -1577,8 +1577,8 @@
15771577
<Parameter Name="chars" Type="System.ReadOnlySpan&lt;System.Char&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
15781578
</Parameters>
15791579
<Docs>
1580-
<param name="chars">To be added.</param>
1581-
<summary>To be added.</summary>
1580+
<param name="chars">A span of chars to write.</param>
1581+
<summary>Writes a span of characters to the current stream, and advances the current position of the stream in accordance with the <see langword="Encoding" /> used and perhaps the specific characters being written to the stream.</summary>
15821582
<remarks>To be added.</remarks>
15831583
</Docs>
15841584
</Member>

0 commit comments

Comments
 (0)