Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
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]>
  • Loading branch information
3 people authored Aug 11, 2020
commit c6a6dfd2a53ca21ed07193fc880bccf0df35c884
12 changes: 10 additions & 2 deletions xml/System.Net.Http.Headers/AuthenticationHeaderValue.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="AuthenticationHeaderValue" FullName="System.Net.Http.Headers.AuthenticationHeaderValue">
<Type Name="AuthenticationHeaderValue" FullName="System.Net.Http.Headers.AuthenticationHeaderValue">
<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" />
<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" />
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.AuthenticationHeaderValue" />
Expand Down Expand Up @@ -380,7 +380,15 @@ Authorization: Bearer ACCESS_TOKEN
<Docs>
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.AuthenticationHeaderValue" /> instance.</summary>
<returns>A copy of the current instance.</returns>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
Expand Down
12 changes: 10 additions & 2 deletions xml/System.Net.Http.Headers/CacheControlHeaderValue.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="CacheControlHeaderValue" FullName="System.Net.Http.Headers.CacheControlHeaderValue">
<Type Name="CacheControlHeaderValue" FullName="System.Net.Http.Headers.CacheControlHeaderValue">
<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" />
<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" />
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.CacheControlHeaderValue" />
Expand Down Expand Up @@ -867,7 +867,15 @@
<Docs>
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.CacheControlHeaderValue" /> instance.</summary>
<returns>A copy of the current instance.</returns>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
Expand Down
12 changes: 10 additions & 2 deletions xml/System.Net.Http.Headers/ContentDispositionHeaderValue.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="ContentDispositionHeaderValue" FullName="System.Net.Http.Headers.ContentDispositionHeaderValue">
<Type Name="ContentDispositionHeaderValue" FullName="System.Net.Http.Headers.ContentDispositionHeaderValue">
<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" />
<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" />
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.ContentDispositionHeaderValue" />
Expand Down Expand Up @@ -592,7 +592,15 @@
<Docs>
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.ContentDispositionHeaderValue" /> instance.</summary>
<returns>A copy of the current instance.</returns>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
Expand Down
12 changes: 10 additions & 2 deletions xml/System.Net.Http.Headers/ContentRangeHeaderValue.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="ContentRangeHeaderValue" FullName="System.Net.Http.Headers.ContentRangeHeaderValue">
<Type Name="ContentRangeHeaderValue" FullName="System.Net.Http.Headers.ContentRangeHeaderValue">
<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" />
<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" />
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.ContentRangeHeaderValue" />
Expand Down Expand Up @@ -436,7 +436,15 @@
<Docs>
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.ContentRangeHeaderValue" /> instance.</summary>
<returns>A copy of the current instance.</returns>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="To">
Expand Down
12 changes: 10 additions & 2 deletions xml/System.Net.Http.Headers/EntityTagHeaderValue.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="EntityTagHeaderValue" FullName="System.Net.Http.Headers.EntityTagHeaderValue">
<Type Name="EntityTagHeaderValue" FullName="System.Net.Http.Headers.EntityTagHeaderValue">
<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" />
<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" />
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.EntityTagHeaderValue" />
Expand Down Expand Up @@ -349,7 +349,15 @@
<Docs>
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.EntityTagHeaderValue" /> instance.</summary>
<returns>A copy of the current instance.</returns>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Tag">
Expand Down
12 changes: 10 additions & 2 deletions xml/System.Net.Http.Headers/HttpHeaderValueCollection`1.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="HttpHeaderValueCollection&lt;T&gt;" FullName="System.Net.Http.Headers.HttpHeaderValueCollection&lt;T&gt;">
<Type Name="HttpHeaderValueCollection&lt;T&gt;" FullName="System.Net.Http.Headers.HttpHeaderValueCollection&lt;T&gt;">
<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" />
<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" />
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.HttpHeaderValueCollection`1" />
Expand Down Expand Up @@ -447,7 +447,15 @@
<Docs>
<summary>Returns an enumerator that iterates through the <see cref="T:System.Net.Http.Headers.HttpHeaderValueCollection`1" />.</summary>
<returns>An enumerator for the <see cref="T:System.Net.Http.Headers.HttpHeaderValueCollection`1" /> instance.</returns>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
Expand Down
12 changes: 10 additions & 2 deletions xml/System.Net.Http.Headers/HttpHeaders.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="HttpHeaders" FullName="System.Net.Http.Headers.HttpHeaders">
<Type Name="HttpHeaders" FullName="System.Net.Http.Headers.HttpHeaders">
<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;" />
<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" />
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.HttpHeaders" />
Expand Down Expand Up @@ -418,7 +418,15 @@ New line characters in header values must be followed by a white-space character
<Docs>
<summary>Gets an enumerator that can iterate through a <see cref="T:System.Net.Http.Headers.HttpHeaders" />.</summary>
<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>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
Expand Down
12 changes: 10 additions & 2 deletions xml/System.Net.Http.Headers/MediaTypeHeaderValue.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="MediaTypeHeaderValue" FullName="System.Net.Http.Headers.MediaTypeHeaderValue">
<Type Name="MediaTypeHeaderValue" FullName="System.Net.Http.Headers.MediaTypeHeaderValue">
<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" />
<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" />
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.MediaTypeHeaderValue" />
Expand Down Expand Up @@ -381,7 +381,15 @@
<Docs>
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.MediaTypeHeaderValue" /> instance.</summary>
<returns>A copy of the current instance.</returns>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
Expand Down
12 changes: 10 additions & 2 deletions xml/System.Net.Http.Headers/MediaTypeWithQualityHeaderValue.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="MediaTypeWithQualityHeaderValue" FullName="System.Net.Http.Headers.MediaTypeWithQualityHeaderValue">
<Type Name="MediaTypeWithQualityHeaderValue" FullName="System.Net.Http.Headers.MediaTypeWithQualityHeaderValue">
<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" />
<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" />
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.MediaTypeWithQualityHeaderValue" />
Expand Down Expand Up @@ -234,7 +234,15 @@
<Docs>
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.MediaTypeWithQualityHeaderValue" /> instance.</summary>
<returns>A copy of the current instance.</returns>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="TryParse">
Expand Down
12 changes: 10 additions & 2 deletions xml/System.Net.Http.Headers/NameValueHeaderValue.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="NameValueHeaderValue" FullName="System.Net.Http.Headers.NameValueHeaderValue">
<Type Name="NameValueHeaderValue" FullName="System.Net.Http.Headers.NameValueHeaderValue">
<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" />
<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" />
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.NameValueHeaderValue" />
Expand Down Expand Up @@ -346,7 +346,15 @@
<Docs>
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.NameValueHeaderValue" /> instance.</summary>
<returns>A copy of the current instance.</returns>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
Expand Down
12 changes: 10 additions & 2 deletions xml/System.Net.Http.Headers/NameValueWithParametersHeaderValue.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="NameValueWithParametersHeaderValue" FullName="System.Net.Http.Headers.NameValueWithParametersHeaderValue">
<Type Name="NameValueWithParametersHeaderValue" FullName="System.Net.Http.Headers.NameValueWithParametersHeaderValue">
<TypeSignature Language="C#" Value="public class NameValueWithParametersHeaderValue : System.Net.Http.Headers.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;netstandard-2.0;netstandard-2.1" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NameValueWithParametersHeaderValue extends System.Net.Http.Headers.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" />
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.NameValueWithParametersHeaderValue" />
Expand Down Expand Up @@ -342,7 +342,15 @@
<Docs>
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.NameValueWithParametersHeaderValue" /> instance.</summary>
<returns>A copy of the current instance.</returns>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Net.Http.Headers.NameValueWithParametersHeaderValue> instance is cast to an <xref:System.ICloneable> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
Expand Down
12 changes: 10 additions & 2 deletions xml/System.Net.Http.Headers/ProductHeaderValue.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="ProductHeaderValue" FullName="System.Net.Http.Headers.ProductHeaderValue">
<Type Name="ProductHeaderValue" FullName="System.Net.Http.Headers.ProductHeaderValue">
<TypeSignature Language="C#" Value="public class ProductHeaderValue" 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" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ProductHeaderValue 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" />
<TypeSignature Language="DocId" Value="T:System.Net.Http.Headers.ProductHeaderValue" />
Expand Down Expand Up @@ -306,7 +306,15 @@
<Docs>
<summary>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.ProductHeaderValue" /> instance.</summary>
<returns>A copy of the current instance.</returns>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Net.Http.Headers.ProductHeaderValue> instance is cast to an <xref:System.ICloneable> interface.

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