Skip to content

Add remarks on disposable ctor parameter to System.Net.Http.StreamCon… #3357

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 3 commits into from
Aug 21, 2020
Merged

Add remarks on disposable ctor parameter to System.Net.Http.StreamCon… #3357

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
55c89fc
Add remarks on disposable ctor parameter to System.Net.Http.StreamCon…
Oct 16, 2019
620efb8
Fix typo in ctor remarks (#3339)
Oct 16, 2019
c9007ee
Apply suggestions from code review
gewarren Aug 3, 2020
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
19 changes: 17 additions & 2 deletions xml/System.Net.Http/StreamContent.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,15 @@
<Docs>
<param name="content">The content used to initialize the <see cref="T:System.Net.Http.StreamContent" />.</param>
<summary>Creates a new instance of the <see cref="T:System.Net.Http.StreamContent" /> class.</summary>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The <xref:System.Net.Http.StreamContent> object calls <xref:System.IO.Stream.Dispose> on the provided <xref:System.IO.Stream> object when <xref:System.Net.Http.StreamContent.Dispose%2A?displayProperty=nameWithType> is called.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -98,7 +106,14 @@
<param name="content">The content used to initialize the <see cref="T:System.Net.Http.StreamContent" />.</param>
<param name="bufferSize">The size, in bytes, of the buffer for the <see cref="T:System.Net.Http.StreamContent" />.</param>
<summary>Creates a new instance of the <see cref="T:System.Net.Http.StreamContent" /> class.</summary>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Net.Http.StreamContent> object calls <xref:System.IO.Stream.Dispose> on the provided <xref:System.IO.Stream> object when <xref:System.Net.Http.StreamContent.Dispose%2A?displayProperty=nameWithType> is called.

]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="content" /> was <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="bufferSize" /> was less than or equal to zero.</exception>
</Docs>
Expand Down