Skip to content

Commit c6788aa

Browse files
authored
Add remarks on disposable ctor parameter to System.Net.Http.StreamCon… (#3357)
* Add remarks on disposable ctor parameter to System.Net.Http.StreamContent (#3339)
1 parent 38b0dc2 commit c6788aa

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

xml/System.Net.Http/StreamContent.xml

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,15 @@
7373
<Docs>
7474
<param name="content">The content used to initialize the <see cref="T:System.Net.Http.StreamContent" />.</param>
7575
<summary>Creates a new instance of the <see cref="T:System.Net.Http.StreamContent" /> class.</summary>
76-
<remarks>To be added.</remarks>
76+
<remarks>
77+
<format type="text/markdown"><![CDATA[
78+
79+
## Remarks
80+
81+
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.
82+
83+
]]></format>
84+
</remarks>
7785
</Docs>
7886
</Member>
7987
<Member MemberName=".ctor">
@@ -107,7 +115,14 @@
107115
<param name="content">The content used to initialize the <see cref="T:System.Net.Http.StreamContent" />.</param>
108116
<param name="bufferSize">The size, in bytes, of the buffer for the <see cref="T:System.Net.Http.StreamContent" />.</param>
109117
<summary>Creates a new instance of the <see cref="T:System.Net.Http.StreamContent" /> class.</summary>
110-
<remarks>To be added.</remarks>
118+
<remarks>
119+
<format type="text/markdown"><![CDATA[
120+
121+
## Remarks
122+
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.
123+
124+
]]></format>
125+
</remarks>
111126
<exception cref="T:System.ArgumentNullException">The <paramref name="content" /> was <see langword="null" />.</exception>
112127
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="bufferSize" /> was less than or equal to zero.</exception>
113128
</Docs>

0 commit comments

Comments
 (0)