Skip to content

Commit 2644c95

Browse files
Document System.Runtime.CompilerServices.ConditionalWeakTable.GetEnumerator (#3668)
* Document System.Runtime.CompilerServices.ConditionalWeakTable.GetEnumerator * suggestions by gewarren Co-Authored-By: Genevieve Warren <[email protected]>
1 parent 5e08b13 commit 2644c95

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

xml/System.Runtime.CompilerServices/ConditionalWeakTable`2.xml

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -562,9 +562,18 @@
562562
</ReturnValue>
563563
<Parameters />
564564
<Docs>
565-
<summary>To be added.</summary>
566-
<returns>To be added.</returns>
567-
<remarks>To be added.</remarks>
565+
<summary>Returns an enumerator that can be used to iterate through the <see cref="T:System.Runtime.CompilerServices.ConditionalWeakTable`2" /> table.</summary>
566+
<returns>An enumerator that can be used to iterate through the <see cref="T:System.Runtime.CompilerServices.ConditionalWeakTable`2" /> table.</returns>
567+
<remarks>
568+
<format type="text/markdown"><![CDATA[
569+
570+
## Remarks
571+
572+
The returned enumerator does not extend the lifetime of any object pairs in the table, other than the current one. It does not return entries that have already been collected or that were added after the enumerator was
573+
retrieved. Additionally, it may not return all entries that were present when the enumerator was retrieved, for example, entries that were collected or removed after the enumerator was retrieved but before they were enumerated.
574+
575+
]]></format>
576+
</remarks>
568577
</Docs>
569578
</Member>
570579
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
@@ -598,9 +607,20 @@
598607
</ReturnValue>
599608
<Parameters />
600609
<Docs>
601-
<summary>To be added.</summary>
602-
<returns>To be added.</returns>
603-
<remarks>To be added.</remarks>
610+
<summary>Returns an enumerator that can be used to iterate through the <see cref="T:System.Runtime.CompilerServices.ConditionalWeakTable`2" /> table.</summary>
611+
<returns>An enumerator that can be used to iterate through the <see cref="T:System.Runtime.CompilerServices.ConditionalWeakTable`2" /> table.</returns>
612+
<remarks>
613+
<format type="text/markdown"><![CDATA[
614+
615+
## Remarks
616+
617+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Runtime.CompilerServices.ConditionalWeakTable%602> instance is cast to an <xref:System.Collections.IEnumerable> interface.
618+
619+
The returned enumerator does not extend the lifetime of any object pairs in the table, other than the current one. It does not return entries that have already been collected or that were added after the enumerator was
620+
retrieved. Additionally, it may not return all entries that were present when the enumerator was retrieved, for example, entries that were collected or removed after the enumerator was retrieved but before they were enumerated.
621+
622+
]]></format>
623+
</remarks>
604624
</Docs>
605625
</Member>
606626
<Member MemberName="TryGetValue">

0 commit comments

Comments
 (0)