Skip to content

Commit c6a6dfd

Browse files
carlossanlopgewarren
carlossanlop
and
gewarren
authored
Automatic port of System.Net documentation (#4620)
* Automatic port of System.Net documentation * Update xml/System.Net.Http.Json/HttpClientJsonExtensions.xml Co-authored-by: Genevieve Warren <[email protected]> * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Apply suggestions to Socket.xml Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Genevieve Warren <[email protected]>
1 parent 70e945a commit c6a6dfd

30 files changed

+335
-90
lines changed

‎xml/System.Net.Http.Headers/AuthenticationHeaderValue.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="AuthenticationHeaderValue" FullName="System.Net.Http.Headers.AuthenticationHeaderValue">
1+
<Type Name="AuthenticationHeaderValue" FullName="System.Net.Http.Headers.AuthenticationHeaderValue">
22
<TypeSignature Language="C#" Value="public class AuthenticationHeaderValue" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AuthenticationHeaderValue extends System.Object" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
44
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.AuthenticationHeaderValue" />
@@ -380,7 +380,15 @@ Authorization: Bearer ACCESS_TOKEN
380380
<Docs>
381381
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.AuthenticationHeaderValue" /> instance.</summary>
382382
<returns>A copy of the current instance.</returns>
383-
<remarks>To be added.</remarks>
383+
<remarks>
384+
<format type="text/markdown"><![CDATA[
385+
386+
## Remarks
387+
388+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Net.Http.Headers.AuthenticationHeaderValue> instance is cast to an <xref:System.ICloneable> interface.
389+
390+
]]></format>
391+
</remarks>
384392
</Docs>
385393
</Member>
386394
<Member MemberName="ToString">

‎xml/System.Net.Http.Headers/CacheControlHeaderValue.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="CacheControlHeaderValue" FullName="System.Net.Http.Headers.CacheControlHeaderValue">
1+
<Type Name="CacheControlHeaderValue" FullName="System.Net.Http.Headers.CacheControlHeaderValue">
22
<TypeSignature Language="C#" Value="public class CacheControlHeaderValue" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CacheControlHeaderValue extends System.Object" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
44
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.CacheControlHeaderValue" />
@@ -867,7 +867,15 @@
867867
<Docs>
868868
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.CacheControlHeaderValue" /> instance.</summary>
869869
<returns>A copy of the current instance.</returns>
870-
<remarks>To be added.</remarks>
870+
<remarks>
871+
<format type="text/markdown"><![CDATA[
872+
873+
## Remarks
874+
875+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Net.Http.Headers.CacheControlHeaderValue> instance is cast to an <xref:System.ICloneable> interface.
876+
877+
]]></format>
878+
</remarks>
871879
</Docs>
872880
</Member>
873881
<Member MemberName="ToString">

‎xml/System.Net.Http.Headers/ContentDispositionHeaderValue.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="ContentDispositionHeaderValue" FullName="System.Net.Http.Headers.ContentDispositionHeaderValue">
1+
<Type Name="ContentDispositionHeaderValue" FullName="System.Net.Http.Headers.ContentDispositionHeaderValue">
22
<TypeSignature Language="C#" Value="public class ContentDispositionHeaderValue" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ContentDispositionHeaderValue extends System.Object" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
44
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.ContentDispositionHeaderValue" />
@@ -592,7 +592,15 @@
592592
<Docs>
593593
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.ContentDispositionHeaderValue" /> instance.</summary>
594594
<returns>A copy of the current instance.</returns>
595-
<remarks>To be added.</remarks>
595+
<remarks>
596+
<format type="text/markdown"><![CDATA[
597+
598+
## Remarks
599+
600+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Net.Http.Headers.ContentDispositionHeaderValue> instance is cast to an <xref:System.ICloneable> interface.
601+
602+
]]></format>
603+
</remarks>
596604
</Docs>
597605
</Member>
598606
<Member MemberName="ToString">

‎xml/System.Net.Http.Headers/ContentRangeHeaderValue.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="ContentRangeHeaderValue" FullName="System.Net.Http.Headers.ContentRangeHeaderValue">
1+
<Type Name="ContentRangeHeaderValue" FullName="System.Net.Http.Headers.ContentRangeHeaderValue">
22
<TypeSignature Language="C#" Value="public class ContentRangeHeaderValue" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ContentRangeHeaderValue extends System.Object" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
44
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.ContentRangeHeaderValue" />
@@ -436,7 +436,15 @@
436436
<Docs>
437437
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.ContentRangeHeaderValue" /> instance.</summary>
438438
<returns>A copy of the current instance.</returns>
439-
<remarks>To be added.</remarks>
439+
<remarks>
440+
<format type="text/markdown"><![CDATA[
441+
442+
## Remarks
443+
444+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Net.Http.Headers.ContentRangeHeaderValue> instance is cast to an <xref:System.ICloneable> interface.
445+
446+
]]></format>
447+
</remarks>
440448
</Docs>
441449
</Member>
442450
<Member MemberName="To">

‎xml/System.Net.Http.Headers/EntityTagHeaderValue.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="EntityTagHeaderValue" FullName="System.Net.Http.Headers.EntityTagHeaderValue">
1+
<Type Name="EntityTagHeaderValue" FullName="System.Net.Http.Headers.EntityTagHeaderValue">
22
<TypeSignature Language="C#" Value="public class EntityTagHeaderValue" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EntityTagHeaderValue extends System.Object" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
44
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.EntityTagHeaderValue" />
@@ -349,7 +349,15 @@
349349
<Docs>
350350
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.EntityTagHeaderValue" /> instance.</summary>
351351
<returns>A copy of the current instance.</returns>
352-
<remarks>To be added.</remarks>
352+
<remarks>
353+
<format type="text/markdown"><![CDATA[
354+
355+
## Remarks
356+
357+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Net.Http.Headers.EntityTagHeaderValue> instance is cast to an <xref:System.ICloneable> interface.
358+
359+
]]></format>
360+
</remarks>
353361
</Docs>
354362
</Member>
355363
<Member MemberName="Tag">

‎xml/System.Net.Http.Headers/HttpHeaderValueCollection`1.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="HttpHeaderValueCollection&lt;T&gt;" FullName="System.Net.Http.Headers.HttpHeaderValueCollection&lt;T&gt;">
1+
<Type Name="HttpHeaderValueCollection&lt;T&gt;" FullName="System.Net.Http.Headers.HttpHeaderValueCollection&lt;T&gt;">
22
<TypeSignature Language="C#" Value="public sealed class HttpHeaderValueCollection&lt;T&gt; : System.Collections.Generic.ICollection&lt;T&gt;, System.Collections.Generic.IEnumerable&lt;T&gt; where T : class" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit HttpHeaderValueCollection`1&lt;class T&gt; extends System.Object implements class System.Collections.Generic.ICollection`1&lt;!T&gt;, class System.Collections.Generic.IEnumerable`1&lt;!T&gt;, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.HttpHeaderValueCollection`1" />
@@ -447,7 +447,15 @@
447447
<Docs>
448448
<summary>Returns an enumerator that iterates through the <see cref="T:System.Net.Http.Headers.HttpHeaderValueCollection`1" />.</summary>
449449
<returns>An enumerator for the <see cref="T:System.Net.Http.Headers.HttpHeaderValueCollection`1" /> instance.</returns>
450-
<remarks>To be added.</remarks>
450+
<remarks>
451+
<format type="text/markdown"><![CDATA[
452+
453+
## Remarks
454+
455+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Net.Http.Headers.HttpHeaderValueCollection`1> instance is cast to an <xref:System.Collections.IEnumerable> interface.
456+
457+
]]></format>
458+
</remarks>
451459
</Docs>
452460
</Member>
453461
<Member MemberName="ToString">

‎xml/System.Net.Http.Headers/HttpHeaders.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="HttpHeaders" FullName="System.Net.Http.Headers.HttpHeaders">
1+
<Type Name="HttpHeaders" FullName="System.Net.Http.Headers.HttpHeaders">
22
<TypeSignature Language="C#" Value="public abstract class HttpHeaders : System.Collections.Generic.IEnumerable&lt;System.Collections.Generic.KeyValuePair&lt;string,System.Collections.Generic.IEnumerable&lt;string&gt;&gt;&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit HttpHeaders extends System.Object implements class System.Collections.Generic.IEnumerable`1&lt;valuetype System.Collections.Generic.KeyValuePair`2&lt;string, class System.Collections.Generic.IEnumerable`1&lt;string&gt;&gt;&gt;, class System.Collections.IEnumerable" FrameworkAlternate="dotnet-uwp-10.0;net-5.0;netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6;netstandard-2.0;netstandard-2.1" />
44
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.HttpHeaders" />
@@ -418,7 +418,15 @@ New line characters in header values must be followed by a white-space character
418418
<Docs>
419419
<summary>Gets an enumerator that can iterate through a <see cref="T:System.Net.Http.Headers.HttpHeaders" />.</summary>
420420
<returns>An instance of an implementation of an <see cref="T:System.Collections.IEnumerator" /> that can iterate through a <see cref="T:System.Net.Http.Headers.HttpHeaders" />.</returns>
421-
<remarks>To be added.</remarks>
421+
<remarks>
422+
<format type="text/markdown"><![CDATA[
423+
424+
## Remarks
425+
426+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Net.Http.Headers.HttpHeaders> instance is cast to an <xref:System.Collections.IEnumerable> interface.
427+
428+
]]></format>
429+
</remarks>
422430
</Docs>
423431
</Member>
424432
<Member MemberName="ToString">

‎xml/System.Net.Http.Headers/MediaTypeHeaderValue.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="MediaTypeHeaderValue" FullName="System.Net.Http.Headers.MediaTypeHeaderValue">
1+
<Type Name="MediaTypeHeaderValue" FullName="System.Net.Http.Headers.MediaTypeHeaderValue">
22
<TypeSignature Language="C#" Value="public class MediaTypeHeaderValue" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MediaTypeHeaderValue extends System.Object" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
44
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.MediaTypeHeaderValue" />
@@ -381,7 +381,15 @@
381381
<Docs>
382382
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.MediaTypeHeaderValue" /> instance.</summary>
383383
<returns>A copy of the current instance.</returns>
384-
<remarks>To be added.</remarks>
384+
<remarks>
385+
<format type="text/markdown"><![CDATA[
386+
387+
## Remarks
388+
389+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Net.Http.Headers.MediaTypeHeaderValue> instance is cast to an <xref:System.ICloneable> interface.
390+
391+
]]></format>
392+
</remarks>
385393
</Docs>
386394
</Member>
387395
<Member MemberName="ToString">

‎xml/System.Net.Http.Headers/MediaTypeWithQualityHeaderValue.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="MediaTypeWithQualityHeaderValue" FullName="System.Net.Http.Headers.MediaTypeWithQualityHeaderValue">
1+
<Type Name="MediaTypeWithQualityHeaderValue" FullName="System.Net.Http.Headers.MediaTypeWithQualityHeaderValue">
22
<TypeSignature Language="C#" Value="public sealed class MediaTypeWithQualityHeaderValue : System.Net.Http.Headers.MediaTypeHeaderValue" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6;netstandard-2.0;netstandard-2.1;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit MediaTypeWithQualityHeaderValue extends System.Net.Http.Headers.MediaTypeHeaderValue" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0" />
44
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.MediaTypeWithQualityHeaderValue" />
@@ -234,7 +234,15 @@
234234
<Docs>
235235
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.MediaTypeWithQualityHeaderValue" /> instance.</summary>
236236
<returns>A copy of the current instance.</returns>
237-
<remarks>To be added.</remarks>
237+
<remarks>
238+
<format type="text/markdown"><![CDATA[
239+
240+
## Remarks
241+
242+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Net.Http.Headers.MediaTypeWithQualityHeaderValue> instance is cast to an <xref:System.ICloneable> interface.
243+
244+
]]></format>
245+
</remarks>
238246
</Docs>
239247
</Member>
240248
<Member MemberName="TryParse">

‎xml/System.Net.Http.Headers/NameValueHeaderValue.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="NameValueHeaderValue" FullName="System.Net.Http.Headers.NameValueHeaderValue">
1+
<Type Name="NameValueHeaderValue" FullName="System.Net.Http.Headers.NameValueHeaderValue">
22
<TypeSignature Language="C#" Value="public class NameValueHeaderValue" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NameValueHeaderValue extends System.Object" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.6" />
44
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.NameValueHeaderValue" />
@@ -346,7 +346,15 @@
346346
<Docs>
347347
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.NameValueHeaderValue" /> instance.</summary>
348348
<returns>A copy of the current instance.</returns>
349-
<remarks>To be added.</remarks>
349+
<remarks>
350+
<format type="text/markdown"><![CDATA[
351+
352+
## Remarks
353+
354+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Net.Http.Headers.NameValueHeaderValue> instance is cast to an <xref:System.ICloneable> interface.
355+
356+
]]></format>
357+
</remarks>
350358
</Docs>
351359
</Member>
352360
<Member MemberName="ToString">

0 commit comments

Comments
 (0)