Skip to content

Commit 4bb2089

Browse files
carlossanlopRon Petrusha
andauthored
some suggestions by rpetrusha
Co-Authored-By: Ron Petrusha <[email protected]>
1 parent 95c51d1 commit 4bb2089

File tree

1 file changed

+42
-23
lines changed

1 file changed

+42
-23
lines changed

xml/System.Text.RegularExpressions/GroupCollection.xml

Lines changed: 42 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@
105105
<Docs>
106106
<param name="key">A string with the name of the captured group to locate.</param>
107107
<summary>Determines whether the group collection contains a captured group identified by the specified name.</summary>
108-
<returns><see langword="true"/> if the group collection contains a captured group identified by the specified key; <see langword="false" /> otherwise.</returns>
108+
<returns><see langword="true"/> if the group collection contains a captured group identified by <paramref name="key" />; <see langword="false" /> otherwise.</returns>
109109
<remarks>To be added.</remarks>
110110
</Docs>
111111
</Member>
@@ -210,17 +210,17 @@
210210
<Parameter Name="arrayIndex" Type="System.Int32" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
211211
</Parameters>
212212
<Docs>
213-
<param name="array">The one-dimensional <see cref="T:System.Text.RegularExpressions.Group[]" /> array that is the destination of the elements copied from the group collection. The array must have zero-based indexing.</param>
214-
<param name="arrayIndex">The zero-based index in the <see cref="T:System.Text.RegularExpressions.Group[]" /> array at which copying begins.</param>
213+
<param name="array">The one-dimensional array that is the destination of the elements copied from the group collection. The array must have zero-based indexing.</param>
214+
<param name="arrayIndex">The zero-based index in <paramref name="array" /> at which copying begins.</param>
215215
<summary>Copies the elements of the group collection to a <see cref="T:System.Text.RegularExpressions.Group[]" /> array, starting at a particular array index.</summary>
216216
<remarks>To be added.</remarks>
217217
<exception cref="T:System.ArgumentNullException"><paramref name="array" /> is null.</exception>
218218
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="arrayIndex" /> is less than zero.
219219

220220
-or-
221221

222-
<paramref name="arrayIndex" /> is greater than the length of <see cref="P:System.Text.RegularExpressions.Group[]" />.</exception>
223-
<exception cref="T:System.ArgumentException">The length of the <paramref name="array" /> - the <paramref name="arrayIndex" /> is less than the group collection count.</exception>
222+
<paramref name="arrayIndex" /> is greater than the length of <paramref name="array" />.</exception>
223+
<exception cref="T:System.ArgumentException">The length of <paramref name="array" /> - <paramref name="arrayIndex" /> is less than the group collection count.</exception>
224224
</Docs>
225225
</Member>
226226
<Member MemberName="Count">
@@ -586,7 +586,7 @@
586586
</ReturnValue>
587587
<Docs>
588588
<summary>Gets a string enumeration that contains the name keys of the group collection.</summary>
589-
<value>A string enumeration.</value>
589+
<value>The name keys of the group collection.</value>
590590
<remarks>To be added.</remarks>
591591
</Docs>
592592
</Member>
@@ -671,8 +671,8 @@
671671
<Parameter Name="item" Type="System.Text.RegularExpressions.Group" Index="0" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
672672
</Parameters>
673673
<Docs>
674-
<param name="item">This method is not supported.</param>
675-
<summary>Implementation from <see cref="T:System.Collections.Generic.ICollection" />. This method is not supported.</summary>
674+
<param name="item">The group to add to the collection.</param>
675+
<summary>Adds a <see cref="T:System.Text.RegularExpressions.Group" /> to the collection. Calling this method always throws <see cref="T:System.NotSupportedException" />.</summary>
676676
<remarks>To be added.</remarks>
677677
<exception cref="T:System.NotSupportedException">This method is not supported. This is a read-only collection.</exception>
678678
</Docs>
@@ -704,7 +704,7 @@
704704
</ReturnValue>
705705
<Parameters />
706706
<Docs>
707-
<summary>Implementation from <see cref="T:System.Collections.Generic.ICollection" />. This method is not supported.</summary>
707+
<summary>Clears the collection. Calling this method always throws <see cref="T:System.NotSupportedException" />.</summary>
708708
<remarks>To be added.</remarks>
709709
<exception cref="T:System.NotSupportedException">This method is not supported. This is a read-only collection.</exception>
710710
</Docs>
@@ -741,7 +741,13 @@
741741
<param name="item">The group to locate in the group collection.</param>
742742
<summary>Determines whether the group collection contains a specific group item.</summary>
743743
<returns><see langword="true" /> if the group item is found in the group collection; <see langword="false" /> otherwise.</returns>
744-
<remarks>To be added.</remarks>
744+
<remarks>
745+
<format type="text/markdown"><![CDATA[
746+
747+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Text.RegularExpressions.GroupCollection> instance is cast to an <xref:System.Collections.Generic.ICollection%601> interface.
748+
749+
]]></format>
750+
</remarks>
745751
</Docs>
746752
</Member>
747753
<Member MemberName="System.Collections.Generic.ICollection&lt;System.Text.RegularExpressions.Group&gt;.Remove">
@@ -773,9 +779,9 @@
773779
<Parameter Name="item" Type="System.Text.RegularExpressions.Group" Index="0" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
774780
</Parameters>
775781
<Docs>
776-
<param name="item">This method is not supported.</param>
777-
<summary>Implementation from <see cref="T:System.Collections.Generic.ICollection" />. This method is not supported.</summary>
778-
<returns>This method is not supported.</returns>
782+
<param name="item">The group to remove.</param>
783+
<summary>Removes a <see cref="T:System.Text.RegularExpressions.Group" /> from the collection. Calling this method always throws <see cref="T:System.NotSupportedException" />.</summary>
784+
<returns>This method is not supported. No value is returned.</returns>
779785
<remarks>To be added.</remarks>
780786
<exception cref="T:System.NotSupportedException">This method is not supported. This is a read-only collection.</exception>
781787
</Docs>
@@ -806,14 +812,15 @@
806812
<Parameters />
807813
<Docs>
808814
<summary>Provides an enumerator that iterates through the group collection.</summary>
809-
<returns>An enumerator that contains all <see cref="T:System.Text.RegularExpressions.Group" /> objects in the group collection.</returns>
815+
<returns>An enumerator that contains all names and objects in the <see cref="T:System.Text.RegularExpressions.Group" /> collection.</returns>
810816
<remarks>
811817
<format type="text/markdown">
812818
<![CDATA[
813819
814820
## Remarks
815821
816-
Instead of calling the <xref:System.Text.RegularExpressions.GroupCollection.GetEnumerator%2A> method to retrieve an enumerator that lets you iterate through the <xref:System.Text.RegularExpressions.Group> objects in the collection, you should use the group iteration construct (such as `foreach` in C# and `For Each`…`Next` in Visual Basic) that is provided by your programming language.
822+
823+
Instead of calling this method to retrieve an enumerator that lets you iterate through the <xref:System.Text.RegularExpressions.Group> objects in the collection, you should use the group iteration construct (such as `foreach` in C# and `For Each`…`Next` in Visual Basic) that is provided by your programming language.
817824
818825
]]>
819826
</format>
@@ -855,7 +862,7 @@ Instead of calling the <xref:System.Text.RegularExpressions.GroupCollection.GetE
855862
856863
## Remarks
857864
858-
Instead of calling the <xref:System.Text.RegularExpressions.GroupCollection.GetEnumerator%2A> method to retrieve an enumerator that lets you iterate through the <xref:System.Text.RegularExpressions.Group> objects in the collection, you should use the group iteration construct (such as `foreach` in C# and `For Each`…`Next` in Visual Basic) that is provided by your programming language.
865+
Instead of calling this method to retrieve an enumerator that lets you iterate through the <xref:System.Text.RegularExpressions.Group> objects in the collection, you should use the group iteration construct (such as `foreach` in C# and `For Each`…`Next` in Visual Basic) that is provided by your programming language.
859866
860867
]]>
861868
</format>
@@ -894,7 +901,13 @@ Instead of calling the <xref:System.Text.RegularExpressions.GroupCollection.GetE
894901
<param name="item">The group to locate in the group collection.</param>
895902
<summary>Determines the index of a specific group in the group collection.</summary>
896903
<returns>The index of the <paramref. name="item" /> if found; otherwise, -1.</returns>
897-
<remarks>To be added.</remarks>
904+
<remarks>
905+
<format type="text/markdown"><![CDATA[
906+
907+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Text.RegularExpressions.GroupCollection> instance is cast to an <xref:System.Collections.Generic.IList%601> interface.
908+
909+
]]></format>
910+
</remarks>
898911
</Docs>
899912
</Member>
900913
<Member MemberName="System.Collections.Generic.IList&lt;System.Text.RegularExpressions.Group&gt;.Insert">
@@ -927,9 +940,9 @@ Instead of calling the <xref:System.Text.RegularExpressions.GroupCollection.GetE
927940
<Parameter Name="item" Type="System.Text.RegularExpressions.Group" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
928941
</Parameters>
929942
<Docs>
930-
<param name="index">This method is not supported.</param>
931-
<param name="item">This method is not supported.</param>
932-
<summary>Implementation from <see cref="T:System.Collections.Generic.IList" />. This method is not supported.</summary>
943+
<param name="index">The position at which to insert the group.</param>
944+
<param name="item">The group to insert.</param>
945+
<summary>Inserts a <see cref="T:System.Text.RegularExpressions.Group" /> into the collection. Calling this method always throws <see cref="T:System.NotSupportedException" />.</summary>
933946
<remarks>To be added.</remarks>
934947
<exception cref="T:System.NotSupportedException">This method is not supported. This is a read-only collection.</exception>
935948
</Docs>
@@ -964,10 +977,16 @@ Instead of calling the <xref:System.Text.RegularExpressions.GroupCollection.GetE
964977
<Parameter Name="index" Type="System.Int32" Index="0" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
965978
</Parameters>
966979
<Docs>
967-
<param name="index">The zero-index position of the group in the group collection.</param>
968-
<summary>Gets the group in the desired position.</summary>
980+
<param name="index">The zero-based index of the group in the group collection.</param>
981+
<summary>Gets the group at the specified position in the collection.</summary>
969982
<value>The group in the desired position.</value>
970-
<remarks>To be added.</remarks>
983+
<remarks>
984+
<format type="text/markdown"><![CDATA[
985+
986+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Text.RegularExpressions.GroupCollection> instance is cast to an <xref:System.Collections.Generic.IList%601> interface.
987+
988+
]]></format>
989+
</remarks>
971990
<exception cref="T:System.NotSupportedException">Cannot set an item. This is a read-only collection.</exception>
972991
</Docs>
973992
</Member>

0 commit comments

Comments
 (0)