Skip to content

Commit 4dd2459

Browse files
author
Ron Petrusha
authored
Moved more enumeration member remarks (#2444)
1 parent 48c3ca8 commit 4dd2459

File tree

5 files changed

+72
-197
lines changed

5 files changed

+72
-197
lines changed

xml/System.Net.Cache/RequestCacheLevel.xml

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@
3535
This <xref:System.Net.Cache.HttpRequestCacheLevel.BypassCache> value is the default cache behavior specified in the machine configuration file that ships with the .NET Framework. No entries are taken from caches, added to caches, or removed from caches between the client and server.
3636
3737
The <xref:System.Net.HttpWebRequest.DefaultCachePolicy%2A?displayProperty=nameWithType> property is used to get or set the default cache policy for <xref:System.Net.HttpWebRequest> instances. The <xref:System.Net.WebRequest.CachePolicy%2A?displayProperty=nameWithType> property is used to get or set the default cache policy for a <xref:System.Net.WebRequest> instances. The <xref:System.Net.WebRequest.CachePolicy%2A?displayProperty=nameWithType> property is used to get or set the cache policy for a specific request.
38-
39-
A copy of a resource is only added to the cache if the response stream for the resource is retrieved and read to the end of the stream. So another request for the same resource could use a cached copy, depending on the default cache policy level for this request.
40-
41-
38+
39+
If the cache behavior is `CacheIfAvailable` or `Revalidate`, a copy of a requested resource is only added to the cache if the response stream for the resource is retrieved and read to the end of the stream. With `CacheIfAvailable`, subsequent requests for the same resource would use a cached copy. With `Revalidate`, subsequent requests for the same resource would use a cached copy if the timestamp for the cached resource is the same as the timestamp of the resource on the server.
40+
41+
A copy of a resource is only added to the cache if the response stream for the resource is retrieved and read to the end of the stream. So another request for the same resource could use a cached copy, depending on the default cache policy level for this request.
4242
4343
## Examples
4444
The following code example creates policy that returns a resource only if it is in the cache.
@@ -116,14 +116,7 @@
116116
<MemberValue>3</MemberValue>
117117
<Docs>
118118
<summary>Satisfies a request for a resource from the cache, if the resource is available; otherwise, sends a request for a resource to the server. If the requested item is available in any cache between the client and the server, the request might be satisfied by the intermediate cache.</summary>
119-
<remarks>
120-
<format type="text/markdown"><![CDATA[
121-
122-
## Remarks
123-
A copy of a requested resource is only added to the cache if the response stream for the resource is retrieved and read to the end of the stream. So subsequent requests for the same resource would use a cached copy.
124-
125-
]]></format>
126-
</remarks>
119+
<remarks>To be added.</remarks>
127120
</Docs>
128121
</Member>
129122
<Member MemberName="CacheOnly">
@@ -284,14 +277,7 @@
284277
<MemberValue>4</MemberValue>
285278
<Docs>
286279
<summary>Satisfies a request by using the cached copy of the resource if the timestamp is the same as the timestamp of the resource on the server; otherwise, the resource is downloaded from the server, presented to the caller, and stored in the cache.</summary>
287-
<remarks>
288-
<format type="text/markdown"><![CDATA[
289-
290-
## Remarks
291-
A copy of a resource is only added to the cache if the response stream for the resource is retrieved and read to the end of the stream. So subsequent requests for the same resource would use a cached copy if the timestamp for the cached resource is the same as the timestamp of the resource on the server.
292-
293-
]]></format>
294-
</remarks>
280+
<remarks>To be added.</remarks>
295281
</Docs>
296282
</Member>
297283
</Members>

xml/System.Net/AuthenticationSchemes.xml

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,15 @@
3737
<format type="text/markdown"><![CDATA[
3838
3939
## Remarks
40-
This enumeration is used to specify the method used to authenticate client requests being processed by <xref:System.Net.HttpListener> objects.
41-
42-
**Note** Basic authentication requires the exchange of a password and should therefore be avoided except in the case of secure, encrypted connections.
43-
44-
45-
40+
41+
This enumeration is used to specify the method used to authenticate client requests being processed by <xref:System.Net.HttpListener> objects.
42+
43+
> [!IMPORTANT]
44+
> Basic authentication requires the exchange of a password and should therefore be avoided except in the case of secure, encrypted connections.
45+
46+
For additional information on basic and digest authentication, see [RFC2617 - HTTP Authentication: Basic and Digest Authentication](https://www.rfc-editor.org/info/rfc2617). This document is available at <https://www.rfc-editor.org>.
47+
48+
4649
## Examples
4750
The following code example demonstrates using the Negotiate enumeration value to specify that clients are authenticated using the Negotiate security protocol.
4851
@@ -119,14 +122,7 @@
119122
<MemberValue>8</MemberValue>
120123
<Docs>
121124
<summary>Specifies basic authentication.</summary>
122-
<remarks>
123-
<format type="text/markdown"><![CDATA[
124-
125-
## Remarks
126-
For additional information, see RFC2617 - HTTP Authentication: Basic and Digest Authentication. This document is available at [https://www.rfc-editor.org](https://www.rfc-editor.org/).
127-
128-
]]></format>
129-
</remarks>
125+
<remarks>To be added.</remarks>
130126
</Docs>
131127
</Member>
132128
<Member MemberName="Digest">
@@ -161,14 +157,7 @@
161157
<MemberValue>1</MemberValue>
162158
<Docs>
163159
<summary>Specifies digest authentication.</summary>
164-
<remarks>
165-
<format type="text/markdown"><![CDATA[
166-
167-
## Remarks
168-
For additional information, see RFC2617 - HTTP Authentication: Basic and Digest Authentication. This document is available at [https://www.rfc-editor.org](https://www.rfc-editor.org/)
169-
170-
]]></format>
171-
</remarks>
160+
<remarks>To be added.</remarks>
172161
</Docs>
173162
</Member>
174163
<Member MemberName="IntegratedWindowsAuthentication">

xml/System.Net/HttpStatusCode.xml

Lines changed: 35 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,22 @@
3636
<remarks>
3737
<format type="text/markdown"><![CDATA[
3838
39-
## Remarks
40-
The <xref:System.Net.HttpStatusCode> enumeration contains the values of the status codes defined in RFC 2616 for HTTP 1.1.
41-
42-
The status of an HTTP request is contained in the <xref:System.Net.HttpWebResponse.StatusCode%2A?displayProperty=nameWithType> property.
43-
44-
39+
## Remarks
40+
41+
The <xref:System.Net.HttpStatusCode> enumeration contains the values of the status codes defined in RFC 2616 for HTTP 1.1.
4542
43+
The status of an HTTP request is contained in the <xref:System.Net.HttpWebResponse.StatusCode%2A?displayProperty=nameWithType> property.
44+
If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, the following enumeration values cause an exception to be thrown:
45+
46+
- `Ambiguous`
47+
- `Found`
48+
- `MultipleChoices`
49+
- `Redirect`
50+
- `RedirectKeepVerb`
51+
- `RedirectMethod`
52+
- `SeeOther`
53+
- `TemporaryRedirect`
54+
4655
## Examples
4756
The following example compares the status returned by an <xref:System.Net.HttpWebResponse> with a member of the <xref:System.Net.HttpStatusCode> class to determine the status of a response.
4857
@@ -159,17 +168,8 @@
159168
</ReturnValue>
160169
<MemberValue>300</MemberValue>
161170
<Docs>
162-
<summary>Equivalent to HTTP status 300. <see cref="F:System.Net.HttpStatusCode.Ambiguous" /> indicates that the requested information has multiple representations. The default action is to treat this status as a redirect and follow the contents of the Location header associated with this response.</summary>
163-
<remarks>
164-
<format type="text/markdown"><![CDATA[
165-
166-
## Remarks
167-
If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, Ambiguous will cause an exception to be thrown.
168-
169-
Ambiguous is a synonym for MultipleChoices.
170-
171-
]]></format>
172-
</remarks>
171+
<summary>Equivalent to HTTP status 300. <see cref="F:System.Net.HttpStatusCode.Ambiguous" /> indicates that the requested information has multiple representations. The default action is to treat this status as a redirect and follow the contents of the Location header associated with this response. <c>Ambiguous</c> is a synonym for <c>MultipleChoices</c>.</summary>
172+
<remarks>To be added.</remarks>
173173
</Docs>
174174
</Member>
175175
<Member MemberName="BadGateway">
@@ -541,17 +541,8 @@
541541
</ReturnValue>
542542
<MemberValue>302</MemberValue>
543543
<Docs>
544-
<summary>Equivalent to HTTP status 302. <see cref="F:System.Net.HttpStatusCode.Found" /> indicates that the requested information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will use the GET method.</summary>
545-
<remarks>
546-
<format type="text/markdown"><![CDATA[
547-
548-
## Remarks
549-
If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, Found will cause an exception to be thrown.
550-
551-
Found is a synonym for Redirect.
552-
553-
]]></format>
554-
</remarks>
544+
<summary>Equivalent to HTTP status 302. <see cref="F:System.Net.HttpStatusCode.Found" /> indicates that the requested information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will use the GET method. <c>Found</c> is a synonym for <c>Redirect</c>.</summary>
545+
<remarks>To be added.</remarks>
555546
</Docs>
556547
</Member>
557548
<Member MemberName="GatewayTimeout">
@@ -974,15 +965,8 @@
974965
</ReturnValue>
975966
<MemberValue>301</MemberValue>
976967
<Docs>
977-
<summary>Equivalent to HTTP status 301. <see cref="F:System.Net.HttpStatusCode.Moved" /> indicates that the requested information has been moved to the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will use the GET method.</summary>
978-
<remarks>
979-
<format type="text/markdown"><![CDATA[
980-
981-
## Remarks
982-
Moved is a synonym for MovedPermanently.
983-
984-
]]></format>
985-
</remarks>
968+
<summary>Equivalent to HTTP status 301. <see cref="F:System.Net.HttpStatusCode.Moved" /> indicates that the requested information has been moved to the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will use the GET method. <c>Moved</c> is a synonym for <c>MovedPermanently</c>.</summary>
969+
<remarks>To be added.</remarks>
986970
</Docs>
987971
</Member>
988972
<Member MemberName="MovedPermanently">
@@ -1021,15 +1005,8 @@
10211005
</ReturnValue>
10221006
<MemberValue>301</MemberValue>
10231007
<Docs>
1024-
<summary>Equivalent to HTTP status 301. <see cref="F:System.Net.HttpStatusCode.MovedPermanently" /> indicates that the requested information has been moved to the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response.</summary>
1025-
<remarks>
1026-
<format type="text/markdown"><![CDATA[
1027-
1028-
## Remarks
1029-
MovedPermanently is a synonym for Moved.
1030-
1031-
]]></format>
1032-
</remarks>
1008+
<summary>Equivalent to HTTP status 301. <see cref="F:System.Net.HttpStatusCode.MovedPermanently" /> indicates that the requested information has been moved to the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. <c>MovedPermanently</c> is a synonym for <c>Moved</c>.</summary>
1009+
<remarks>To be added.</remarks>
10331010
</Docs>
10341011
</Member>
10351012
<Member MemberName="MultipleChoices">
@@ -1068,17 +1045,8 @@
10681045
</ReturnValue>
10691046
<MemberValue>300</MemberValue>
10701047
<Docs>
1071-
<summary>Equivalent to HTTP status 300. <see cref="F:System.Net.HttpStatusCode.MultipleChoices" /> indicates that the requested information has multiple representations. The default action is to treat this status as a redirect and follow the contents of the Location header associated with this response.</summary>
1072-
<remarks>
1073-
<format type="text/markdown"><![CDATA[
1074-
1075-
## Remarks
1076-
If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, MultipleChoices will cause an exception to be thrown.
1077-
1078-
MultipleChoices is a synonym for Ambiguous.
1079-
1080-
]]></format>
1081-
</remarks>
1048+
<summary>Equivalent to HTTP status 300. <see cref="F:System.Net.HttpStatusCode.MultipleChoices" /> indicates that the requested information has multiple representations. The default action is to treat this status as a redirect and follow the contents of the Location header associated with this response. <c>MultipleChoices</c> is a synonym for <c>Ambiguous</c>.</summary>
1049+
<remarks>To be added.</remarks>
10821050
</Docs>
10831051
</Member>
10841052
<Member MemberName="MultiStatus">
@@ -1726,17 +1694,8 @@
17261694
</ReturnValue>
17271695
<MemberValue>302</MemberValue>
17281696
<Docs>
1729-
<summary>Equivalent to HTTP status 302. <see cref="F:System.Net.HttpStatusCode.Redirect" /> indicates that the requested information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will use the GET method.</summary>
1730-
<remarks>
1731-
<format type="text/markdown"><![CDATA[
1732-
1733-
## Remarks
1734-
If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, Redirect will cause an exception to be thrown.
1735-
1736-
Redirect is a synonym for Found.
1737-
1738-
]]></format>
1739-
</remarks>
1697+
<summary>Equivalent to HTTP status 302. <see cref="F:System.Net.HttpStatusCode.Redirect" /> indicates that the requested information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will use the GET method. <c>Redirect</c> is a synonym for <c>Found</c>.</summary>
1698+
<remarks>To be added.</remarks>
17401699
</Docs>
17411700
</Member>
17421701
<Member MemberName="RedirectKeepVerb">
@@ -1775,17 +1734,8 @@
17751734
</ReturnValue>
17761735
<MemberValue>307</MemberValue>
17771736
<Docs>
1778-
<summary>Equivalent to HTTP status 307. <see cref="F:System.Net.HttpStatusCode.RedirectKeepVerb" /> indicates that the request information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will also use the POST method.</summary>
1779-
<remarks>
1780-
<format type="text/markdown"><![CDATA[
1781-
1782-
## Remarks
1783-
If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, RedirectKeepVerb will cause an exception to be thrown.
1784-
1785-
RedirectKeepVerb is a synonym for TemporaryRedirect.
1786-
1787-
]]></format>
1788-
</remarks>
1737+
<summary>Equivalent to HTTP status 307. <see cref="F:System.Net.HttpStatusCode.RedirectKeepVerb" /> indicates that the request information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will also use the POST method. <c>RedirectKeepVerb</c> is a synonym for <c>TemporaryRedirect</c>.</summary>
1738+
<remarks>To be added.</remarks>
17891739
</Docs>
17901740
</Member>
17911741
<Member MemberName="RedirectMethod">
@@ -1824,17 +1774,8 @@
18241774
</ReturnValue>
18251775
<MemberValue>303</MemberValue>
18261776
<Docs>
1827-
<summary>Equivalent to HTTP status 303. <see cref="F:System.Net.HttpStatusCode.RedirectMethod" /> automatically redirects the client to the URI specified in the Location header as the result of a POST. The request to the resource specified by the Location header will be made with a GET.</summary>
1828-
<remarks>
1829-
<format type="text/markdown"><![CDATA[
1830-
1831-
## Remarks
1832-
If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, RedirectMethod will cause an exception to be thrown.
1833-
1834-
RedirectMethod is a synonym for SeeOther.
1835-
1836-
]]></format>
1837-
</remarks>
1777+
<summary>Equivalent to HTTP status 303. <see cref="F:System.Net.HttpStatusCode.RedirectMethod" /> automatically redirects the client to the URI specified in the Location header as the result of a POST. The request to the resource specified by the Location header will be made with a GET. <c>RedirectMethod</c> is a synonym for <c>SeeOther</c>.</summary>
1778+
<remarks>To be added.</remarks>
18381779
</Docs>
18391780
</Member>
18401781
<Member MemberName="RequestedRangeNotSatisfiable">
@@ -2098,17 +2039,8 @@
20982039
</ReturnValue>
20992040
<MemberValue>303</MemberValue>
21002041
<Docs>
2101-
<summary>Equivalent to HTTP status 303. <see cref="F:System.Net.HttpStatusCode.SeeOther" /> automatically redirects the client to the URI specified in the Location header as the result of a POST. The request to the resource specified by the Location header will be made with a GET.</summary>
2102-
<remarks>
2103-
<format type="text/markdown"><![CDATA[
2104-
2105-
## Remarks
2106-
If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, SeeOther will cause an exception to be thrown.
2107-
2108-
SeeOther is a synonym for RedirectMethod.
2109-
2110-
]]></format>
2111-
</remarks>
2042+
<summary>Equivalent to HTTP status 303. <see cref="F:System.Net.HttpStatusCode.SeeOther" /> automatically redirects the client to the URI specified in the Location header as the result of a POST. The request to the resource specified by the Location header will be made with a GET. <c>SeeOther</c> is a synonym for <c>RedirectMethod</c></summary>
2043+
<remarks>To be added.</remarks>
21122044
</Docs>
21132045
</Member>
21142046
<Member MemberName="ServiceUnavailable">
@@ -2225,17 +2157,8 @@
22252157
</ReturnValue>
22262158
<MemberValue>307</MemberValue>
22272159
<Docs>
2228-
<summary>Equivalent to HTTP status 307. <see cref="F:System.Net.HttpStatusCode.TemporaryRedirect" /> indicates that the request information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will also use the POST method.</summary>
2229-
<remarks>
2230-
<format type="text/markdown"><![CDATA[
2231-
2232-
## Remarks
2233-
If the <xref:System.Net.HttpWebRequest.AllowAutoRedirect%2A?displayProperty=nameWithType> property is `false`, TemporaryRedirect will cause an exception to be thrown.
2234-
2235-
TemporaryRedirect is a synonym for RedirectKeepVerb.
2236-
2237-
]]></format>
2238-
</remarks>
2160+
<summary>Equivalent to HTTP status 307. <see cref="F:System.Net.HttpStatusCode.TemporaryRedirect" /> indicates that the request information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will also use the POST method. <c>TemporaryRedirect</c> is a synonym for <c>RedirectKeepVerb</c>.</summary>
2161+
<remarks>To be added.</remarks>
22392162
</Docs>
22402163
</Member>
22412164
<Member MemberName="TooManyRequests">

0 commit comments

Comments
 (0)