Skip to content

Commit 35a84c3

Browse files
carlossanlopcarlossanlop
authored
Automatic port of System.ComponentModel documentation (#4672)
Co-authored-by: carlossanlop <[email protected]>
1 parent a85d07b commit 35a84c3

8 files changed

+181
-21
lines changed

‎xml/System.ComponentModel/AttributeCollection.xml

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -999,7 +999,15 @@
999999
<summary>Gets a value indicating whether access to the collection is synchronized (thread-safe).</summary>
10001000
<value>
10011001
<see langword="true" /> if access to the collection is synchronized (thread-safe); otherwise, <see langword="false" />.</value>
1002-
<remarks>To be added.</remarks>
1002+
<remarks>
1003+
<format type="text/markdown"><![CDATA[
1004+
1005+
## Remarks
1006+
1007+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.AttributeCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
1008+
1009+
]]></format>
1010+
</remarks>
10031011
</Docs>
10041012
</Member>
10051013
<Member MemberName="System.Collections.ICollection.SyncRoot">
@@ -1038,7 +1046,15 @@
10381046
<Docs>
10391047
<summary>Gets an object that can be used to synchronize access to the collection.</summary>
10401048
<value>An object that can be used to synchronize access to the collection.</value>
1041-
<remarks>To be added.</remarks>
1049+
<remarks>
1050+
<format type="text/markdown"><![CDATA[
1051+
1052+
## Remarks
1053+
1054+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.AttributeCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
1055+
1056+
]]></format>
1057+
</remarks>
10421058
</Docs>
10431059
</Member>
10441060
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
@@ -1084,7 +1100,15 @@
10841100
<Docs>
10851101
<summary>Returns an <see cref="T:System.Collections.IEnumerator" /> for the <see cref="T:System.Collections.IDictionary" />.</summary>
10861102
<returns>An <see cref="T:System.Collections.IEnumerator" /> for the <see cref="T:System.Collections.IDictionary" />.</returns>
1087-
<remarks>To be added.</remarks>
1103+
<remarks>
1104+
<format type="text/markdown"><![CDATA[
1105+
1106+
## Remarks
1107+
1108+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.AttributeCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
1109+
1110+
]]></format>
1111+
</remarks>
10881112
</Docs>
10891113
</Member>
10901114
</Members>

‎xml/System.ComponentModel/BackgroundWorker.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@
289289
</ReturnValue>
290290
<Parameters />
291291
<Docs>
292-
<summary>To be added.</summary>
292+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
293293
<remarks>To be added.</remarks>
294294
</Docs>
295295
</Member>

‎xml/System.ComponentModel/BindingList`1.xml

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1845,7 +1845,15 @@
18451845
<summary>Gets a value indicating whether new items can be added to the list using the <see cref="M:System.ComponentModel.BindingList`1.AddNew" /> method.</summary>
18461846
<value>
18471847
<see langword="true" /> if you can add items to the list with the <see cref="M:System.ComponentModel.BindingList`1.AddNew" /> method; otherwise, <see langword="false" />. The default depends on the underlying type contained in the list.</value>
1848-
<remarks>To be added.</remarks>
1848+
<remarks>
1849+
<format type="text/markdown"><![CDATA[
1850+
1851+
## Remarks
1852+
1853+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.BindingList`1> instance is cast to an <xref:System.ComponentModel.IBindingList> interface.
1854+
1855+
]]></format>
1856+
</remarks>
18491857
</Docs>
18501858
</Member>
18511859
<Member MemberName="System.ComponentModel.IBindingList.AllowRemove">
@@ -1890,7 +1898,15 @@
18901898
<summary>Gets a value indicating whether items can be removed from the list.</summary>
18911899
<value>
18921900
<see langword="true" /> if you can remove items from the list with the <see cref="M:System.ComponentModel.BindingList`1.RemoveItem(System.Int32)" /> method; otherwise, <see langword="false" />. The default is <see langword="true" />.</value>
1893-
<remarks>To be added.</remarks>
1901+
<remarks>
1902+
<format type="text/markdown"><![CDATA[
1903+
1904+
## Remarks
1905+
1906+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.BindingList`1> instance is cast to an <xref:System.ComponentModel.IBindingList> interface.
1907+
1908+
]]></format>
1909+
</remarks>
18941910
</Docs>
18951911
</Member>
18961912
<Member MemberName="System.ComponentModel.IBindingList.ApplySort">

‎xml/System.ComponentModel/GroupDescription.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,15 @@
336336
</ReturnValue>
337337
<Docs>
338338
<summary>Occurs when a property value changes.</summary>
339-
<remarks>To be added.</remarks>
339+
<remarks>
340+
<format type="text/markdown"><![CDATA[
341+
342+
## Remarks
343+
344+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.GroupDescription> instance is cast to an <xref:System.ComponentModel.INotifyPropertyChanged> interface.
345+
346+
]]></format>
347+
</remarks>
340348
</Docs>
341349
</Member>
342350
</Members>

‎xml/System.ComponentModel/ListSortDescriptionCollection.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,15 @@
489489
<Docs>
490490
<summary>Gets a <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.</summary>
491491
<returns>An <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.</returns>
492-
<remarks>To be added.</remarks>
492+
<remarks>
493+
<format type="text/markdown"><![CDATA[
494+
495+
## Remarks
496+
497+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.ListSortDescriptionCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
498+
499+
]]></format>
500+
</remarks>
493501
</Docs>
494502
</Member>
495503
<Member MemberName="System.Collections.IList.Add">

‎xml/System.ComponentModel/PropertyDescriptorCollection.xml

Lines changed: 99 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1253,7 +1253,15 @@
12531253
<summary>Gets a value indicating whether access to the collection is synchronized (thread safe).</summary>
12541254
<value>
12551255
<see langword="true" /> if access to the collection is synchronized (thread safe); otherwise, <see langword="false" />.</value>
1256-
<remarks>To be added.</remarks>
1256+
<remarks>
1257+
<format type="text/markdown"><![CDATA[
1258+
1259+
## Remarks
1260+
1261+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.PropertyDescriptorCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
1262+
1263+
]]></format>
1264+
</remarks>
12571265
</Docs>
12581266
</Member>
12591267
<Member MemberName="System.Collections.ICollection.SyncRoot">
@@ -1292,7 +1300,15 @@
12921300
<Docs>
12931301
<summary>Gets an object that can be used to synchronize access to the collection.</summary>
12941302
<value>An object that can be used to synchronize access to the collection.</value>
1295-
<remarks>To be added.</remarks>
1303+
<remarks>
1304+
<format type="text/markdown"><![CDATA[
1305+
1306+
## Remarks
1307+
1308+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.PropertyDescriptorCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
1309+
1310+
]]></format>
1311+
</remarks>
12961312
</Docs>
12971313
</Member>
12981314
<Member MemberName="System.Collections.IDictionary.Add">
@@ -1385,7 +1401,15 @@
13851401
<Parameters />
13861402
<Docs>
13871403
<summary>Removes all elements from the <see cref="T:System.Collections.IDictionary" />.</summary>
1388-
<remarks>To be added.</remarks>
1404+
<remarks>
1405+
<format type="text/markdown"><![CDATA[
1406+
1407+
## Remarks
1408+
1409+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.PropertyDescriptorCollection> instance is cast to an <xref:System.Collections.IDictionary> interface.
1410+
1411+
]]></format>
1412+
</remarks>
13891413
</Docs>
13901414
</Member>
13911415
<Member MemberName="System.Collections.IDictionary.Contains">
@@ -1525,7 +1549,15 @@
15251549
<summary>Gets a value indicating whether the <see cref="T:System.Collections.IDictionary" /> has a fixed size.</summary>
15261550
<value>
15271551
<see langword="true" /> if the <see cref="T:System.Collections.IDictionary" /> has a fixed size; otherwise, <see langword="false" />.</value>
1528-
<remarks>To be added.</remarks>
1552+
<remarks>
1553+
<format type="text/markdown"><![CDATA[
1554+
1555+
## Remarks
1556+
1557+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.PropertyDescriptorCollection> instance is cast to an <xref:System.Collections.IDictionary> interface.
1558+
1559+
]]></format>
1560+
</remarks>
15291561
</Docs>
15301562
</Member>
15311563
<Member MemberName="System.Collections.IDictionary.IsReadOnly">
@@ -1565,7 +1597,15 @@
15651597
<summary>Gets a value indicating whether the <see cref="T:System.Collections.IDictionary" /> is read-only.</summary>
15661598
<value>
15671599
<see langword="true" /> if the <see cref="T:System.Collections.IDictionary" /> is read-only; otherwise, <see langword="false" />.</value>
1568-
<remarks>To be added.</remarks>
1600+
<remarks>
1601+
<format type="text/markdown"><![CDATA[
1602+
1603+
## Remarks
1604+
1605+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.PropertyDescriptorCollection> instance is cast to an <xref:System.Collections.IDictionary> interface.
1606+
1607+
]]></format>
1608+
</remarks>
15691609
</Docs>
15701610
</Member>
15711611
<Member MemberName="System.Collections.IDictionary.Item">
@@ -1647,7 +1687,15 @@
16471687
<Docs>
16481688
<summary>Gets an <see cref="T:System.Collections.ICollection" /> containing the keys of the <see cref="T:System.Collections.IDictionary" />.</summary>
16491689
<value>An <see cref="T:System.Collections.ICollection" /> containing the keys of the <see cref="T:System.Collections.IDictionary" />.</value>
1650-
<remarks>To be added.</remarks>
1690+
<remarks>
1691+
<format type="text/markdown"><![CDATA[
1692+
1693+
## Remarks
1694+
1695+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.PropertyDescriptorCollection> instance is cast to an <xref:System.Collections.IDictionary> interface.
1696+
1697+
]]></format>
1698+
</remarks>
16511699
</Docs>
16521700
</Member>
16531701
<Member MemberName="System.Collections.IDictionary.Remove">
@@ -1729,7 +1777,15 @@
17291777
<Docs>
17301778
<summary>Gets an <see cref="T:System.Collections.ICollection" /> containing the values in the <see cref="T:System.Collections.IDictionary" />.</summary>
17311779
<value>An <see cref="T:System.Collections.ICollection" /> containing the values in the <see cref="T:System.Collections.IDictionary" />.</value>
1732-
<remarks>To be added.</remarks>
1780+
<remarks>
1781+
<format type="text/markdown"><![CDATA[
1782+
1783+
## Remarks
1784+
1785+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.PropertyDescriptorCollection> instance is cast to an <xref:System.Collections.IDictionary> interface.
1786+
1787+
]]></format>
1788+
</remarks>
17331789
</Docs>
17341790
</Member>
17351791
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
@@ -1775,7 +1831,15 @@
17751831
<Docs>
17761832
<summary>Returns an <see cref="T:System.Collections.IEnumerator" /> for the <see cref="T:System.Collections.IDictionary" />.</summary>
17771833
<returns>An <see cref="T:System.Collections.IEnumerator" /> for the <see cref="T:System.Collections.IDictionary" />.</returns>
1778-
<remarks>To be added.</remarks>
1834+
<remarks>
1835+
<format type="text/markdown"><![CDATA[
1836+
1837+
## Remarks
1838+
1839+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.PropertyDescriptorCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
1840+
1841+
]]></format>
1842+
</remarks>
17791843
</Docs>
17801844
</Member>
17811845
<Member MemberName="System.Collections.IList.Add">
@@ -1864,7 +1928,15 @@
18641928
<Parameters />
18651929
<Docs>
18661930
<summary>Removes all items from the collection.</summary>
1867-
<remarks>To be added.</remarks>
1931+
<remarks>
1932+
<format type="text/markdown"><![CDATA[
1933+
1934+
## Remarks
1935+
1936+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.PropertyDescriptorCollection> instance is cast to an <xref:System.Collections.IList> interface.
1937+
1938+
]]></format>
1939+
</remarks>
18681940
<exception cref="T:System.NotSupportedException">The collection is read-only.</exception>
18691941
</Docs>
18701942
</Member>
@@ -2040,7 +2112,15 @@
20402112
<summary>Gets a value indicating whether the collection has a fixed size.</summary>
20412113
<value>
20422114
<see langword="true" /> if the collection has a fixed size; otherwise, <see langword="false" />.</value>
2043-
<remarks>To be added.</remarks>
2115+
<remarks>
2116+
<format type="text/markdown"><![CDATA[
2117+
2118+
## Remarks
2119+
2120+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.PropertyDescriptorCollection> instance is cast to an <xref:System.Collections.IList> interface.
2121+
2122+
]]></format>
2123+
</remarks>
20442124
</Docs>
20452125
</Member>
20462126
<Member MemberName="System.Collections.IList.IsReadOnly">
@@ -2080,7 +2160,15 @@
20802160
<summary>Gets a value indicating whether the collection is read-only.</summary>
20812161
<value>
20822162
<see langword="true" /> if the collection is read-only; otherwise, <see langword="false" />.</value>
2083-
<remarks>To be added.</remarks>
2163+
<remarks>
2164+
<format type="text/markdown"><![CDATA[
2165+
2166+
## Remarks
2167+
2168+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.PropertyDescriptorCollection> instance is cast to an <xref:System.Collections.IList> interface.
2169+
2170+
]]></format>
2171+
</remarks>
20842172
</Docs>
20852173
</Member>
20862174
<Member MemberName="System.Collections.IList.Item">

‎xml/System.ComponentModel/SortDescriptionCollection.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,15 @@
264264
</ReturnValue>
265265
<Docs>
266266
<summary>Occurs when an item is added or removed.</summary>
267-
<remarks>To be added.</remarks>
267+
<remarks>
268+
<format type="text/markdown"><![CDATA[
269+
270+
## Remarks
271+
272+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.SortDescriptionCollection> instance is cast to an <xref:System.Collections.Specialized.INotifyCollectionChanged> interface.
273+
274+
]]></format>
275+
</remarks>
268276
</Docs>
269277
</Member>
270278
</Members>

‎xml/System.ComponentModel/TypeConverter+StandardValuesCollection.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -511,7 +511,15 @@
511511
<Docs>
512512
<summary>For a description of this member, see <see cref="M:System.Collections.IEnumerable.GetEnumerator" />.</summary>
513513
<returns>An <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.</returns>
514-
<remarks>To be added.</remarks>
514+
<remarks>
515+
<format type="text/markdown"><![CDATA[
516+
517+
## Remarks
518+
519+
This member is an explicit interface member implementation. It can be used only when the <xref:System.ComponentModel.TypeConverter.StandardValuesCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
520+
521+
]]></format>
522+
</remarks>
515523
<altmember cref="T:System.Collections.IEnumerable" />
516524
</Docs>
517525
</Member>

0 commit comments

Comments
 (0)