Skip to content

Commit 85bce73

Browse files
MSDN-WhiteKnightgewarren
authored andcommitted
Update GC.xml (#3559)
- Format identifiers as xrefs to avoid localizing them - Remove "Notes for inheritors" block (it makes no sense for GC which is static class you can't inherit from), and move its contents to remarks - Replace MSDN links to MS Docs
1 parent c5faff8 commit 85bce73

File tree

1 file changed

+27
-29
lines changed

1 file changed

+27
-29
lines changed

xml/System/GC.xml

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
</remarks>
9494
<altmember cref="T:System.Runtime.GCSettings" />
9595
<related type="Article" href="~/docs/standard/garbage-collection/index.md">Garbage Collection</related>
96-
<related type="Article" href="https://msdn.microsoft.com/library/67c5a20d-1be1-4ea7-8a9a-92b0b08658d2">Fundamentals of Garbage Collection</related>
96+
<related type="Article" href="~/docs/standard/garbage-collection/fundamentals.md">Fundamentals of Garbage Collection</related>
9797
</Docs>
9898
<Members>
9999
<Member MemberName="AddMemoryPressure">
@@ -218,7 +218,7 @@
218218
<exception cref="T:System.InvalidOperationException">This member is not available when concurrent garbage collection is enabled. See the [&lt;gcConcurrent&gt;](~/docs/framework/configure-apps/file-schema/runtime/gcconcurrent-element.md) runtime setting for information about how to disable concurrent garbage collection.</exception>
219219
<permission cref="F:System.Security.Permissions.SecurityAction.LinkDemand">for full trust for the immediate caller. This member cannot be used by partially trusted code.</permission>
220220
<permission cref="T:System.Security.SecurityCriticalAttribute">requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.</permission>
221-
<related type="Article" href="https://msdn.microsoft.com/library/e12d8e74-31e3-4035-a87d-f3e66f0a9b89">Garbage Collection Notifications</related>
221+
<related type="Article" href="~/docs/standard/garbage-collection/notifications.md">Garbage Collection Notifications</related>
222222
</Docs>
223223
</Member>
224224
<MemberGroup MemberName="Collect">
@@ -298,7 +298,7 @@
298298
299299
]]></format>
300300
</remarks>
301-
<related type="Article" href="https://msdn.microsoft.com/library/019008fe-4708-4e65-bebf-04fd9941e149">Induced Collections</related>
301+
<related type="Article" href="~/docs/standard/garbage-collection/induced.md">Induced Collections</related>
302302
</Docs>
303303
</Member>
304304
<Member MemberName="Collect">
@@ -364,7 +364,7 @@
364364
</remarks>
365365
<exception cref="T:System.ArgumentOutOfRangeException">
366366
<paramref name="generation" /> is not valid.</exception>
367-
<related type="Article" href="https://msdn.microsoft.com/library/019008fe-4708-4e65-bebf-04fd9941e149">Induced Collections</related>
367+
<related type="Article" href="~/docs/standard/garbage-collection/induced.md">Induced Collections</related>
368368
</Docs>
369369
</Member>
370370
<Member MemberName="Collect">
@@ -441,7 +441,7 @@
441441
-or-
442442

443443
<paramref name="mode" /> is not one of the <see cref="T:System.GCCollectionMode" /> values.</exception>
444-
<related type="Article" href="https://msdn.microsoft.com/library/019008fe-4708-4e65-bebf-04fd9941e149">Induced Collections</related>
444+
<related type="Article" href="~/docs/standard/garbage-collection/induced.md">Induced Collections</related>
445445
</Docs>
446446
</Member>
447447
<Member MemberName="Collect">
@@ -699,7 +699,7 @@
699699
A memory allocation exceeded the amount specified in the call to the <see cref="M:System.GC.TryStartNoGCRegion(System.Int64)" /> method.</exception>
700700
<altmember cref="M:System.GC.TryStartNoGCRegion(System.Int64)" />
701701
<altmember cref="P:System.Runtime.GCSettings.LatencyMode" />
702-
<related type="Article" href="https://msdn.microsoft.com/library/96278bb7-6eab-4612-8594-ceebfc887d81">Latency Modes</related>
702+
<related type="Article" href="~/docs/standard/garbage-collection/latency.md">Latency Modes</related>
703703
</Docs>
704704
</Member>
705705
<Member MemberName="GetAllocatedBytesForCurrentThread">
@@ -1118,22 +1118,20 @@ This method is most useful in monitoring scenarios for measuring the difference
11181118
11191119
If object aging is implemented, the <xref:System.GC.MaxGeneration%2A> property returns the maximum generation number used by the system; otherwise, this property returns zero.
11201120
1121-
1121+
For this implementation, the value returned by the <xref:System.GC.MaxGeneration> property is guaranteed to remain constant for the lifetime of an executing application.
11221122
1123+
Use the <xref:System.GC.MaxGeneration> property to determine the maximum value you can specify when calling the <xref:System.GC.Collect%28System.Int32%29> method that takes a generation parameter.
1124+
1125+
11231126
## Examples
1124-
The following example demonstrates how to use the MaxGeneration property to display the largest generation number currently in use.
1127+
The following example demonstrates how to use the <xref:System.GC.MaxGeneration> property to display the largest generation number currently in use.
11251128
11261129
[!code-cpp[System.GC.Collect Int Example#1](~/samples/snippets/cpp/VS_Snippets_CLR_System/system.gc.collect int example/CPP/class1.cpp#1)]
11271130
[!code-csharp[System.GC.Collect Int Example#1](~/samples/snippets/csharp/VS_Snippets_CLR_System/system.gc.collect int example/CS/class1.cs#1)]
11281131
[!code-vb[System.GC.Collect Int Example#1](~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.gc.collect int example/VB/class1.vb#1)]
11291132
11301133
]]></format>
1131-
</remarks>
1132-
<block subset="none" type="overrides">
1133-
<para>For this implementation, the value returned by the <see cref="P:System.GC.MaxGeneration" /> property is guaranteed to remain constant for the lifetime of an executing application.
1134-
1135-
Use the <see cref="P:System.GC.MaxGeneration" /> property to determine the maximum value you can specify when calling the <see cref="M:System.GC.Collect(System.Int32)" /> method that takes a generation parameter.</para>
1136-
</block>
1134+
</remarks>
11371135
<altmember cref="M:System.GC.GetGeneration(System.Object)" />
11381136
</Docs>
11391137
</Member>
@@ -1220,7 +1218,7 @@ This method is most useful in monitoring scenarios for measuring the difference
12201218
<paramref name="maxGenerationThreshold" /> or <paramref name="largeObjectHeapThreshold" /> is not between 1 and 99.</exception>
12211219
<permission cref="F:System.Security.Permissions.SecurityAction.LinkDemand">for full trust for the immediate caller. This member cannot be used by partially trusted code.</permission>
12221220
<permission cref="T:System.Security.SecurityCriticalAttribute">requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.</permission>
1223-
<related type="Article" href="https://msdn.microsoft.com/library/e12d8e74-31e3-4035-a87d-f3e66f0a9b89">Garbage Collection Notifications</related>
1221+
<related type="Article" href="~/docs/standard/garbage-collection/notifications.md">Garbage Collection Notifications</related>
12241222
<exception cref="T:System.InvalidOperationException">This member is not available when concurrent garbage collection is enabled. See the &lt;gcConcurrent&gt; runtime setting for information about how to disable concurrent garbage collection.</exception>
12251223
</Docs>
12261224
</Member>
@@ -1349,7 +1347,7 @@ This method is most useful in monitoring scenarios for measuring the difference
13491347
13501348
13511349
## Examples
1352-
The following example demonstrates how to use the ReRegisterForFinalize method to finalize an object a second time after garbage collection.
1350+
The following example demonstrates how to use the <xref:System.GC.ReRegisterForFinalize%2A> method to finalize an object a second time after garbage collection.
13531351
13541352
[!code-cpp[System.GC.ReregisterForFinalize Example#1](~/samples/snippets/cpp/VS_Snippets_CLR_System/system.GC.ReRegisterForFinalize Example/CPP/class1.cpp#1)]
13551353
[!code-csharp[System.GC.ReregisterForFinalize Example#1](~/samples/snippets/csharp/VS_Snippets_CLR_System/system.GC.ReRegisterForFinalize Example/CS/class1.cs#1)]
@@ -1435,7 +1433,7 @@ If `obj` does not have a finalizer or the GC has already signaled the finalizer
14351433
<paramref name="obj" /> is <see langword="null" />.</exception>
14361434
<altmember cref="M:System.GC.ReRegisterForFinalize(System.Object)" />
14371435
<altmember cref="M:System.Object.Finalize" />
1438-
<related type="Article" href="https://msdn.microsoft.com/library/31a6c13b-d6a2-492b-9a9f-e5238c983bcb">Dispose Pattern</related>
1436+
<related type="Article" href="~/docs/standard/garbage-collection/implementing-dispose.md">Dispose Pattern</related>
14391437
</Docs>
14401438
</Member>
14411439
<MemberGroup MemberName="TryStartNoGCRegion">
@@ -1517,8 +1515,8 @@ If `obj` does not have a finalizer or the GC has already signaled the finalizer
15171515
<paramref name="totalSize" /> exceeds the ephemeral segment size.</exception>
15181516
<exception cref="T:System.InvalidOperationException">The process is already in no GC region latency mode.</exception>
15191517
<altmember cref="M:System.GC.EndNoGCRegion" />
1520-
<related type="Article" href="https://msdn.microsoft.com/library/67c5a20d-1be1-4ea7-8a9a-92b0b08658d2">Fundamentals of Garbage Collection</related>
1521-
<related type="Article" href="https://msdn.microsoft.com/library/96278bb7-6eab-4612-8594-ceebfc887d81">Latency Modes</related>
1518+
<related type="Article" href="~/docs/standard/garbage-collection/fundamentals.md">Fundamentals of Garbage Collection</related>
1519+
<related type="Article" href="~/docs/standard/garbage-collection/latency.md">Latency Modes</related>
15221520
</Docs>
15231521
</Member>
15241522
<Member MemberName="TryStartNoGCRegion">
@@ -1584,8 +1582,8 @@ If `obj` does not have a finalizer or the GC has already signaled the finalizer
15841582
<paramref name="totalSize" /> exceeds the ephemeral segment size.</exception>
15851583
<exception cref="T:System.InvalidOperationException">The process is already in no GC region latency mode.</exception>
15861584
<altmember cref="M:System.GC.EndNoGCRegion" />
1587-
<related type="Article" href="https://msdn.microsoft.com/library/67c5a20d-1be1-4ea7-8a9a-92b0b08658d2">Fundamentals of Garbage Collection</related>
1588-
<related type="Article" href="https://msdn.microsoft.com/library/96278bb7-6eab-4612-8594-ceebfc887d81">Latency Modes</related>
1585+
<related type="Article" href="~/docs/standard/garbage-collection/fundamentals.md">Fundamentals of Garbage Collection</related>
1586+
<related type="Article" href="~/docs/standard/garbage-collection/latency.md">Latency Modes</related>
15891587
</Docs>
15901588
</Member>
15911589
<Member MemberName="TryStartNoGCRegion">
@@ -1648,8 +1646,8 @@ If `obj` does not have a finalizer or the GC has already signaled the finalizer
16481646
<paramref name="totalSize" /> - <paramref name="lohSize" /> exceeds the ephemeral segment size.</exception>
16491647
<exception cref="T:System.InvalidOperationException">The process is already in no GC region latency mode.</exception>
16501648
<altmember cref="M:System.GC.EndNoGCRegion" />
1651-
<related type="Article" href="https://msdn.microsoft.com/library/67c5a20d-1be1-4ea7-8a9a-92b0b08658d2">Fundamentals of Garbage Collection</related>
1652-
<related type="Article" href="https://msdn.microsoft.com/library/96278bb7-6eab-4612-8594-ceebfc887d81">Latency Modes</related>
1649+
<related type="Article" href="~/docs/standard/garbage-collection/fundamentals.md">Fundamentals of Garbage Collection</related>
1650+
<related type="Article" href="~/docs/standard/garbage-collection/latency.md">Latency Modes</related>
16531651
</Docs>
16541652
</Member>
16551653
<Member MemberName="TryStartNoGCRegion">
@@ -1717,8 +1715,8 @@ If `obj` does not have a finalizer or the GC has already signaled the finalizer
17171715
<paramref name="totalSize" /> - <paramref name="lohSize" /> exceeds the ephemeral segment size.</exception>
17181716
<exception cref="T:System.InvalidOperationException">The process is already in no GC region latency mode.</exception>
17191717
<altmember cref="M:System.GC.EndNoGCRegion" />
1720-
<related type="Article" href="https://msdn.microsoft.com/library/67c5a20d-1be1-4ea7-8a9a-92b0b08658d2">Fundamentals of Garbage Collection</related>
1721-
<related type="Article" href="https://msdn.microsoft.com/library/96278bb7-6eab-4612-8594-ceebfc887d81">Latency Modes</related>
1718+
<related type="Article" href="~/docs/standard/garbage-collection/fundamentals.md">Fundamentals of Garbage Collection</related>
1719+
<related type="Article" href="~/docs/standard/garbage-collection/latency.md">Latency Modes</related>
17221720
</Docs>
17231721
</Member>
17241722
<MemberGroup MemberName="WaitForFullGCApproach">
@@ -1792,7 +1790,7 @@ If `obj` does not have a finalizer or the GC has already signaled the finalizer
17921790
</remarks>
17931791
<permission cref="F:System.Security.Permissions.SecurityAction.LinkDemand">for full trust for the immediate caller. This member cannot be used by partially trusted code.</permission>
17941792
<permission cref="T:System.Security.SecurityCriticalAttribute">requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.</permission>
1795-
<related type="Article" href="https://msdn.microsoft.com/library/e12d8e74-31e3-4035-a87d-f3e66f0a9b89">Garbage Collection Notifications</related>
1793+
<related type="Article" href="~/docs/standard/garbage-collection/notifications.md">Garbage Collection Notifications</related>
17961794
</Docs>
17971795
</Member>
17981796
<Member MemberName="WaitForFullGCApproach">
@@ -1854,7 +1852,7 @@ If `obj` does not have a finalizer or the GC has already signaled the finalizer
18541852
<paramref name="millisecondsTimeout" /> must be either non-negative or less than or equal to <see cref="F:System.Int32.MaxValue" /> or -1.</exception>
18551853
<permission cref="F:System.Security.Permissions.SecurityAction.LinkDemand">for full trust for the immediate caller. This member cannot be used by partially trusted code.</permission>
18561854
<permission cref="T:System.Security.SecurityCriticalAttribute">requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.</permission>
1857-
<related type="Article" href="https://msdn.microsoft.com/library/e12d8e74-31e3-4035-a87d-f3e66f0a9b89">Garbage Collection Notifications</related>
1855+
<related type="Article" href="~/docs/standard/garbage-collection/notifications.md">Garbage Collection Notifications</related>
18581856
</Docs>
18591857
</Member>
18601858
<MemberGroup MemberName="WaitForFullGCComplete">
@@ -1928,7 +1926,7 @@ If `obj` does not have a finalizer or the GC has already signaled the finalizer
19281926
</remarks>
19291927
<permission cref="F:System.Security.Permissions.SecurityAction.LinkDemand">for full trust for the immediate caller. This member cannot be used by partially trusted code.</permission>
19301928
<permission cref="T:System.Security.SecurityCriticalAttribute">requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.</permission>
1931-
<related type="Article" href="https://msdn.microsoft.com/library/e12d8e74-31e3-4035-a87d-f3e66f0a9b89">Garbage Collection Notifications</related>
1929+
<related type="Article" href="~/docs/standard/garbage-collection/notifications.md">Garbage Collection Notifications</related>
19321930
</Docs>
19331931
</Member>
19341932
<Member MemberName="WaitForFullGCComplete">
@@ -1990,7 +1988,7 @@ If `obj` does not have a finalizer or the GC has already signaled the finalizer
19901988
<paramref name="millisecondsTimeout" /> must be either non-negative or less than or equal to <see cref="F:System.Int32.MaxValue" /> or -1.</exception>
19911989
<permission cref="F:System.Security.Permissions.SecurityAction.LinkDemand">for full trust for the immediate caller. This member cannot be used by partially trusted code.</permission>
19921990
<permission cref="T:System.Security.SecurityCriticalAttribute">requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.</permission>
1993-
<related type="Article" href="https://msdn.microsoft.com/library/e12d8e74-31e3-4035-a87d-f3e66f0a9b89">Garbage Collection Notifications</related>
1991+
<related type="Article" href="~/docs/standard/garbage-collection/notifications.md">Garbage Collection Notifications</related>
19941992
</Docs>
19951993
</Member>
19961994
<Member MemberName="WaitForPendingFinalizers">

0 commit comments

Comments
 (0)