Skip to content

Commit 3523e16

Browse files
authored
Remove .NET Framework remarks (System.Net.*) (#12646)
1 parent e231d9f commit 3523e16

33 files changed

Lines changed: 1131 additions & 2212 deletions

xml/System.Net.Cache/HttpCacheAgeControl.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
5454
## Examples
5555
The following code example creates a policy based on MaxAgeAndMinFresh.
56-
56+
5757
:::code language="csharp" source="~/snippets/csharp/System.Net/WebRequest/CachePolicy/example.cs" id="Snippet9":::
5858
5959
]]></format>
@@ -300,7 +300,7 @@
300300
</ReturnValue>
301301
<MemberValue>0</MemberValue>
302302
<Docs>
303-
<summary>For internal use only. The Framework will throw an <see cref="T:System.ArgumentException" /> if you try to use this member.</summary>
303+
<summary>For internal use only. An <see cref="T:System.ArgumentException" /> is thrown if you try to use this member.</summary>
304304
</Docs>
305305
</Member>
306306
</Members>

xml/System.Net.Cache/HttpRequestCacheLevel.xml

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,25 +49,15 @@
4949
## Remarks
5050
This enumeration is used to set the cache level specified by <xref:System.Net.Cache.HttpRequestCachePolicy> objects.
5151
52-
This `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.
53-
5452
The <xref:System.Net.HttpWebRequest.DefaultCachePolicy?displayProperty=nameWithType> property is used to get or set the default cache policy for <xref:System.Net.HttpWebRequest> instances. The <xref:System.Net.WebRequest.DefaultCachePolicy?displayProperty=nameWithType> property is used to get or set the default cache policy for a <xref:System.Net.WebRequest> instance. The <xref:System.Net.WebRequest.CachePolicy> property is used to get or set the cache policy for a specific request.
5553
5654
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.
5755
58-
59-
60-
## Examples
61-
The following code example sets the application domain's caching policy to Default.
62-
63-
:::code language="csharp" source="~/snippets/csharp/System.Net/WebRequest/CachePolicy/example.cs" id="Snippet2":::
64-
6556
]]></format>
6657
</remarks>
6758
<altmember cref="P:System.Net.HttpWebRequest.DefaultCachePolicy" />
6859
<altmember cref="P:System.Net.WebRequest.CachePolicy" />
6960
<related type="Article" href="/dotnet/framework/network-programming/cache-management-for-network-applications">Cache Management for Network Applications</related>
70-
<related type="Article" href="/dotnet/framework/configure-apps/file-schema/network/requestcaching-element-network-settings">RequestCaching Element (Network Settings)</related>
7161
</Docs>
7262
<Members>
7363
<Member MemberName="BypassCache">
@@ -107,7 +97,7 @@
10797
</ReturnValue>
10898
<MemberValue>1</MemberValue>
10999
<Docs>
110-
<summary>Satisfies a request by using the server. No entries are taken from caches, added to caches, or removed from caches between the client and server. No entries are taken from caches, added to caches, or removed from caches between the client and server. This is the default cache behavior specified in the machine configuration file that ships with the .NET Framework.</summary>
100+
<summary>Satisfies a request by using the server. No entries are taken from caches, added to caches, or removed from caches between the client and server.</summary>
111101
</Docs>
112102
</Member>
113103
<Member MemberName="CacheIfAvailable">

xml/System.Net.Cache/HttpRequestCachePolicy.xml

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -48,19 +48,12 @@
4848
<format type="text/markdown"><![CDATA[
4949
5050
## Remarks
51-
You can specify a default cache policy for your application by using the <xref:System.Net.HttpWebRequest.DefaultCachePolicy> property or the application or machine configuration files. For more information, see [&lt;requestCaching&gt; Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/requestcaching-element-network-settings).
51+
You can specify a default cache policy for your application by using the <xref:System.Net.HttpWebRequest.DefaultCachePolicy> property.
5252
5353
You can specify the cache policy for an individual request by using the <xref:System.Net.WebRequest.CachePolicy> property.
5454
5555
Caching for Web services is not supported.
5656
57-
58-
59-
## Examples
60-
The following code example creates a default cache policy for the application domain, and overrides it for a request.
61-
62-
:::code language="csharp" source="~/snippets/csharp/System.Net/WebRequest/CachePolicy/example.cs" id="Snippet2":::
63-
6457
]]></format>
6558
</remarks>
6659
<related type="Article" href="/dotnet/framework/network-programming/cache-management-for-network-applications">Cache Management for Network Applications</related>
@@ -527,14 +520,7 @@
527520
<format type="text/markdown"><![CDATA[
528521
529522
## Remarks
530-
Applications typically use <xref:System.Net.Cache.HttpRequestCacheLevel.Default> as their cache policy level. The <xref:System.Net.WebRequest.CachePolicy> property, if not `null`, determines the cache policy in effect for a request. The default policy for the application domain can be set using the <xref:System.Net.HttpWebRequest.DefaultCachePolicy> property or by settings in the machine or application configuration files. For more information, see [&lt;requestCaching&gt; Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/requestcaching-element-network-settings).
531-
532-
533-
534-
## Examples
535-
The following code example demonstrates displaying the value of this property.
536-
537-
:::code language="csharp" source="~/snippets/csharp/System.Net/WebRequest/CachePolicy/example.cs" id="Snippet11":::
523+
Applications typically use <xref:System.Net.Cache.HttpRequestCacheLevel.Default> as their cache policy level. The <xref:System.Net.WebRequest.CachePolicy> property, if not `null`, determines the cache policy in effect for a request. The default policy can be set using the <xref:System.Net.HttpWebRequest.DefaultCachePolicy> property.
538524
539525
]]></format>
540526
</remarks>

xml/System.Net.Cache/RequestCacheLevel.xml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,6 @@
4949
## Remarks
5050
Members of this enumeration are used to initialize <xref:System.Net.Cache.RequestCachePolicy> objects. The current setting for a <xref:System.Net.Cache.RequestCachePolicy> object is available in the <xref:System.Net.Cache.HttpRequestCachePolicy.Level?displayProperty=nameWithType> property.
5151
52-
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.
53-
5452
The <xref:System.Net.HttpWebRequest.DefaultCachePolicy?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?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?displayProperty=nameWithType> property is used to get or set the cache policy for a specific request.
5553
5654
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.
@@ -67,7 +65,6 @@ A copy of a resource is only added to the cache if the response stream for the r
6765
<altmember cref="P:System.Net.HttpWebRequest.DefaultCachePolicy" />
6866
<altmember cref="P:System.Net.WebRequest.CachePolicy" />
6967
<related type="Article" href="/dotnet/framework/network-programming/cache-management-for-network-applications">Cache Management for Network Applications</related>
70-
<related type="Article" href="/dotnet/framework/configure-apps/file-schema/network/requestcaching-element-network-settings">RequestCaching Element (Network Settings)</related>
7168
</Docs>
7269
<Members>
7370
<Member MemberName="BypassCache">
@@ -107,7 +104,7 @@ A copy of a resource is only added to the cache if the response stream for the r
107104
</ReturnValue>
108105
<MemberValue>1</MemberValue>
109106
<Docs>
110-
<summary>Satisfies a request by using the server. No entries are taken from caches, added to caches, or removed from caches between the client and server. This is the default cache behavior specified in the machine configuration file that ships with the .NET Framework.</summary>
107+
<summary>Satisfies a request by using the server. No entries are taken from caches, added to caches, or removed from caches between the client and server.</summary>
111108
</Docs>
112109
</Member>
113110
<Member MemberName="CacheIfAvailable">

xml/System.Net.Cache/RequestCachePolicy.xml

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,12 @@
4848
<format type="text/markdown"><![CDATA[
4949
5050
## Remarks
51-
You can specify a default cache policy for your application by using the <xref:System.Net.HttpWebRequest.DefaultCachePolicy> property or the application or machine configuration files. For more information, see [&lt;requestCaching&gt; Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/requestcaching-element-network-settings).
51+
You can specify a default cache policy for your application by using the <xref:System.Net.HttpWebRequest.DefaultCachePolicy> property.
5252
5353
You can specify the cache policy for an individual request by using the <xref:System.Net.WebRequest.CachePolicy> property.
5454
5555
Caching for Web services is not supported.
5656
57-
58-
5957
## Examples
6058
The following code example creates a policy with <xref:System.Net.Cache.RequestCachePolicy.Level*> set to <xref:System.Net.Cache.RequestCacheLevel.CacheOnly>, and uses it to set the cache policy of a <xref:System.Net.WebRequest>.
6159
@@ -231,14 +229,7 @@
231229
## Remarks
232230
Applications typically use <xref:System.Net.Cache.RequestCacheLevel.Default> as their cache policy level. Using the <xref:System.Net.Cache.RequestCacheLevel.Default> level, the effective cache policy is determined by the current cache policy and the age of the content in the cache. The <xref:System.Net.WebRequest.CachePolicy?displayProperty=nameWithType> property, if not `null`, determines the cache policy in effect for a request.
233231
234-
The default policy for the application domain can be set using the <xref:System.Net.HttpWebRequest.DefaultCachePolicy*> or the application or machine configuration file. For more information, see [&lt;requestCaching&gt; Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/requestcaching-element-network-settings).
235-
236-
237-
238-
## Examples
239-
The following code example creates a <xref:System.Net.Cache.RequestCacheLevel.CacheOnly> policy and sends a request.
240-
241-
:::code language="csharp" source="~/snippets/csharp/System.Net/WebRequest/CachePolicy/example.cs" id="Snippet13":::
232+
You can set the default policy using the <xref:System.Net.HttpWebRequest.DefaultCachePolicy> property.
242233
243234
]]></format>
244235
</remarks>

0 commit comments

Comments
 (0)