Skip to content

Commit d416fcb

Browse files
carlossanlopcarlossanlop
authored
Automatically port 5.0 System.Collections documentation (#4294)
* Automatically port 5.0 System.Collections documentation * Add exceptions
1 parent 6555ffd commit d416fcb

15 files changed

+382
-73
lines changed

‎xml/System.Collections.Concurrent/BlockingCollection`1.xml

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1169,7 +1169,15 @@
11691169
<Docs>
11701170
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe).</summary>
11711171
<value>Always returns <see langword="false" /> to indicate the access is not synchronized.</value>
1172-
<remarks>To be added.</remarks>
1172+
<remarks>
1173+
<format type="text/markdown"><![CDATA[
1174+
1175+
## Remarks
1176+
1177+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.BlockingCollection`1> instance is cast to an <xref:System.Collections.ICollection> interface.
1178+
1179+
]]></format>
1180+
</remarks>
11731181
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
11741182
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
11751183
<related type="Article" href="/dotnet/standard/collections/thread-safe/blockingcollection-overview">BlockingCollection Overview</related>
@@ -1209,8 +1217,16 @@
12091217
</ReturnValue>
12101218
<Docs>
12111219
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />. This property is not supported.</summary>
1212-
<value>returns null.</value>
1213-
<remarks>To be added.</remarks>
1220+
<value>Returns <see langword="null" />.</value>
1221+
<remarks>
1222+
<format type="text/markdown"><![CDATA[
1223+
1224+
## Remarks
1225+
1226+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.BlockingCollection`1> instance is cast to an <xref:System.Collections.ICollection> interface.
1227+
1228+
]]></format>
1229+
</remarks>
12141230
<exception cref="T:System.NotSupportedException">The SyncRoot property is not supported.</exception>
12151231
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
12161232
<related type="Article" href="/dotnet/standard/collections/thread-safe/blockingcollection-overview">BlockingCollection Overview</related>
@@ -1252,7 +1268,15 @@
12521268
<Docs>
12531269
<summary>Provides an <see cref="T:System.Collections.IEnumerator" /> for items in the collection.</summary>
12541270
<returns>An <see cref="T:System.Collections.IEnumerator" /> for the items in the collection.</returns>
1255-
<remarks>To be added.</remarks>
1271+
<remarks>
1272+
<format type="text/markdown"><![CDATA[
1273+
1274+
## Remarks
1275+
1276+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.BlockingCollection`1> instance is cast to an <xref:System.Collections.IEnumerable> interface.
1277+
1278+
]]></format>
1279+
</remarks>
12561280
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
12571281
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
12581282
<related type="Article" href="/dotnet/standard/collections/thread-safe/blockingcollection-overview">BlockingCollection Overview</related>

‎xml/System.Collections.Concurrent/ConcurrentBag`1.xml

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -553,7 +553,15 @@
553553
<Docs>
554554
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized with the SyncRoot.</summary>
555555
<value>Always returns <see langword="false" /> to indicate access is not synchronized.</value>
556-
<remarks>To be added.</remarks>
556+
<remarks>
557+
<format type="text/markdown"><![CDATA[
558+
559+
## Remarks
560+
561+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.ConcurrentBag`1> instance is cast to an <xref:System.Collections.ICollection> interface.
562+
563+
]]></format>
564+
</remarks>
557565
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
558566
</Docs>
559567
</Member>
@@ -591,8 +599,16 @@
591599
</ReturnValue>
592600
<Docs>
593601
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />. This property is not supported.</summary>
594-
<value>Returns null (Nothing in Visual Basic).</value>
595-
<remarks>To be added.</remarks>
602+
<value>Returns <see langword="null" />.</value>
603+
<remarks>
604+
<format type="text/markdown"><![CDATA[
605+
606+
## Remarks
607+
608+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.ConcurrentBag`1> instance is cast to an <xref:System.Collections.ICollection> interface.
609+
610+
]]></format>
611+
</remarks>
596612
<exception cref="T:System.NotSupportedException">The SyncRoot property is not supported.</exception>
597613
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
598614
</Docs>

‎xml/System.Collections.Concurrent/ConcurrentDictionary`2.xml

Lines changed: 77 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1634,7 +1634,15 @@
16341634
<summary>Gets a value that indicates whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized with the SyncRoot.</summary>
16351635
<value>
16361636
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />. For <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> this property always returns <see langword="false" />.</value>
1637-
<remarks>To be added.</remarks>
1637+
<remarks>
1638+
<format type="text/markdown"><![CDATA[
1639+
1640+
## Remarks
1641+
1642+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.ConcurrentDictionary`2> instance is cast to an <xref:System.Collections.ICollection> interface.
1643+
1644+
]]></format>
1645+
</remarks>
16381646
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
16391647
<related type="Article" href="/dotnet/standard/collections/thread-safe/how-to-add-and-remove-items">How to: Add and Remove Items from a ConcurrentDictionary</related>
16401648
</Docs>
@@ -1674,7 +1682,15 @@
16741682
<Docs>
16751683
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />. This property is not supported.</summary>
16761684
<value>Always returns null.</value>
1677-
<remarks>To be added.</remarks>
1685+
<remarks>
1686+
<format type="text/markdown"><![CDATA[
1687+
1688+
## Remarks
1689+
1690+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.ConcurrentDictionary`2> instance is cast to an <xref:System.Collections.ICollection> interface.
1691+
1692+
]]></format>
1693+
</remarks>
16781694
<exception cref="T:System.NotSupportedException">This property is not supported.</exception>
16791695
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
16801696
<related type="Article" href="/dotnet/standard/collections/thread-safe/how-to-add-and-remove-items">How to: Add and Remove Items from a ConcurrentDictionary</related>
@@ -1821,7 +1837,15 @@
18211837
<Docs>
18221838
<summary>Provides a <see cref="T:System.Collections.IDictionaryEnumerator" /> for the <see cref="T:System.Collections.Generic.IDictionary`2" />.</summary>
18231839
<returns>A <see cref="T:System.Collections.IDictionaryEnumerator" /> for the <see cref="T:System.Collections.Generic.IDictionary`2" />.</returns>
1824-
<remarks>To be added.</remarks>
1840+
<remarks>
1841+
<format type="text/markdown"><![CDATA[
1842+
1843+
## Remarks
1844+
1845+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.ConcurrentDictionary`2> instance is cast to an <xref:System.Collections.IDictionary> interface.
1846+
1847+
]]></format>
1848+
</remarks>
18251849
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
18261850
<related type="Article" href="/dotnet/standard/collections/thread-safe/how-to-add-and-remove-items">How to: Add and Remove Items from a ConcurrentDictionary</related>
18271851
</Docs>
@@ -1862,7 +1886,15 @@
18621886
<summary>Gets a value that indicates whether the <see cref="T:System.Collections.Generic.IDictionary`2" /> has a fixed size.</summary>
18631887
<value>
18641888
<see langword="true" /> if the <see cref="T:System.Collections.Generic.IDictionary`2" /> has a fixed size; otherwise, <see langword="false" />. For <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />, this property always returns <see langword="false" />.</value>
1865-
<remarks>To be added.</remarks>
1889+
<remarks>
1890+
<format type="text/markdown"><![CDATA[
1891+
1892+
## Remarks
1893+
1894+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.ConcurrentDictionary`2> instance is cast to an <xref:System.Collections.IDictionary> interface.
1895+
1896+
]]></format>
1897+
</remarks>
18661898
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
18671899
<related type="Article" href="/dotnet/standard/collections/thread-safe/how-to-add-and-remove-items">How to: Add and Remove Items from a ConcurrentDictionary</related>
18681900
</Docs>
@@ -1903,7 +1935,15 @@
19031935
<summary>Gets a value that indicates whether the <see cref="T:System.Collections.Generic.IDictionary`2" /> is read-only.</summary>
19041936
<value>
19051937
<see langword="true" /> if the <see cref="T:System.Collections.Generic.IDictionary`2" /> is read-only; otherwise, <see langword="false" />. For <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />, this property always returns <see langword="false" />.</value>
1906-
<remarks>To be added.</remarks>
1938+
<remarks>
1939+
<format type="text/markdown"><![CDATA[
1940+
1941+
## Remarks
1942+
1943+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.ConcurrentDictionary`2> instance is cast to an <xref:System.Collections.IDictionary> interface.
1944+
1945+
]]></format>
1946+
</remarks>
19071947
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
19081948
<related type="Article" href="/dotnet/standard/collections/thread-safe/how-to-add-and-remove-items">How to: Add and Remove Items from a ConcurrentDictionary</related>
19091949
</Docs>
@@ -1990,7 +2030,15 @@
19902030
<Docs>
19912031
<summary>Gets an <see cref="T:System.Collections.ICollection" /> that contains the keys of the <see cref="T:System.Collections.Generic.IDictionary`2" />.</summary>
19922032
<value>An interface that contains the keys of the <see cref="T:System.Collections.Generic.IDictionary`2" />.</value>
1993-
<remarks>To be added.</remarks>
2033+
<remarks>
2034+
<format type="text/markdown"><![CDATA[
2035+
2036+
## Remarks
2037+
2038+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.ConcurrentDictionary`2> instance is cast to an <xref:System.Collections.IDictionary> interface.
2039+
2040+
]]></format>
2041+
</remarks>
19942042
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
19952043
<related type="Article" href="/dotnet/standard/collections/thread-safe/how-to-add-and-remove-items">How to: Add and Remove Items from a ConcurrentDictionary</related>
19962044
</Docs>
@@ -2075,7 +2123,15 @@
20752123
<Docs>
20762124
<summary>Gets an <see cref="T:System.Collections.ICollection" /> that contains the values in the <see cref="T:System.Collections.IDictionary" />.</summary>
20772125
<value>An interface that contains the values in the <see cref="T:System.Collections.IDictionary" />.</value>
2078-
<remarks>To be added.</remarks>
2126+
<remarks>
2127+
<format type="text/markdown"><![CDATA[
2128+
2129+
## Remarks
2130+
2131+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.ConcurrentDictionary`2> instance is cast to an <xref:System.Collections.IDictionary> interface.
2132+
2133+
]]></format>
2134+
</remarks>
20792135
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
20802136
<related type="Article" href="/dotnet/standard/collections/thread-safe/how-to-add-and-remove-items">How to: Add and Remove Items from a ConcurrentDictionary</related>
20812137
</Docs>
@@ -2303,10 +2359,20 @@
23032359
<Parameter Name="item" Type="System.Collections.Generic.KeyValuePair&lt;TKey,TValue&gt;" Index="0" FrameworkAlternate="net-5.0" />
23042360
</Parameters>
23052361
<Docs>
2306-
<param name="item">To be added.</param>
2307-
<summary>To be added.</summary>
2308-
<returns>To be added.</returns>
2309-
<remarks>To be added.</remarks>
2362+
<param name="item">The <see cref="T:System.Collections.Generic.KeyValuePair`2" /> representing the key and value to remove.</param>
2363+
<summary>Removes a key and value from the dictionary.</summary>
2364+
<returns>
2365+
<see langword="true" /> if the key and value represented by <paramref name="item" /> are successfully found and removed; otherwise, <see langword="false" />.</returns>
2366+
<remarks>
2367+
<format type="text/markdown"><![CDATA[
2368+
2369+
## Remarks
2370+
2371+
Both the specifed key and value must match the entry in the dictionary for it to be removed.
2372+
The key is compared using the dictionary's comparer (or the default comparer for <typeparamref name="TKey> if no comparer was provided to the dictionary when it was constructed). The value is compared using the default comparer for <typeparamref name="TValue>.
2373+
2374+
]]></format>
2375+
</remarks>
23102376
</Docs>
23112377
</Member>
23122378
<Member MemberName="TryRemove">

‎xml/System.Collections.Concurrent/ConcurrentQueue`1.xml

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -629,7 +629,15 @@
629629
<Docs>
630630
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized with the SyncRoot.</summary>
631631
<value>Always returns <see langword="false" /> to indicate access is not synchronized.</value>
632-
<remarks>To be added.</remarks>
632+
<remarks>
633+
<format type="text/markdown"><![CDATA[
634+
635+
## Remarks
636+
637+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.ConcurrentQueue`1> instance is cast to an <xref:System.Collections.ICollection> interface.
638+
639+
]]></format>
640+
</remarks>
633641
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
634642
</Docs>
635643
</Member>
@@ -667,8 +675,16 @@
667675
</ReturnValue>
668676
<Docs>
669677
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />. This property is not supported.</summary>
670-
<value>Returns null (Nothing in Visual Basic).</value>
671-
<remarks>To be added.</remarks>
678+
<value>Returns <see langword="null" />.</value>
679+
<remarks>
680+
<format type="text/markdown"><![CDATA[
681+
682+
## Remarks
683+
684+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.ConcurrentQueue`1> instance is cast to an <xref:System.Collections.ICollection> interface.
685+
686+
]]></format>
687+
</remarks>
672688
<exception cref="T:System.NotSupportedException">The SyncRoot property is not supported.</exception>
673689
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
674690
</Docs>
@@ -709,7 +725,15 @@
709725
<Docs>
710726
<summary>Returns an enumerator that iterates through a collection.</summary>
711727
<returns>An <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.</returns>
712-
<remarks>To be added.</remarks>
728+
<remarks>
729+
<format type="text/markdown"><![CDATA[
730+
731+
## Remarks
732+
733+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.ConcurrentQueue`1> instance is cast to an <xref:System.Collections.IEnumerable> interface.
734+
735+
]]></format>
736+
</remarks>
713737
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
714738
</Docs>
715739
</Member>

‎xml/System.Collections.Concurrent/ConcurrentStack`1.xml

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -755,7 +755,15 @@
755755
<Docs>
756756
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized with the SyncRoot.</summary>
757757
<value>Always returns <see langword="false" /> to indicate access is not synchronized.</value>
758-
<remarks>To be added.</remarks>
758+
<remarks>
759+
<format type="text/markdown"><![CDATA[
760+
761+
## Remarks
762+
763+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.ConcurrentStack`1> instance is cast to an <xref:System.Collections.ICollection> interface.
764+
765+
]]></format>
766+
</remarks>
759767
</Docs>
760768
</Member>
761769
<Member MemberName="System.Collections.ICollection.SyncRoot">
@@ -792,8 +800,16 @@
792800
</ReturnValue>
793801
<Docs>
794802
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />. This property is not supported.</summary>
795-
<value>Returns null (Nothing in Visual Basic).</value>
796-
<remarks>To be added.</remarks>
803+
<value>Returns <see langword="null" />.</value>
804+
<remarks>
805+
<format type="text/markdown"><![CDATA[
806+
807+
## Remarks
808+
809+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Concurrent.ConcurrentStack`1> instance is cast to an <xref:System.Collections.ICollection> interface.
810+
811+
]]></format>
812+
</remarks>
797813
<exception cref="T:System.NotSupportedException">The SyncRoot property is not supported</exception>
798814
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
799815
</Docs>

0 commit comments

Comments
 (0)