Skip to content

Commit d2cd895

Browse files
GrabYourPitchforksRon Petrusha
GrabYourPitchforks
authored and
Ron Petrusha
committed
Initial docs for StringRuneEnumerator and SpanRuneEnumerator (#2821)
* Initial docs for StringRuneEnumerator and SpanRuneEnumerator * Update xml/System.Text/SpanRuneEnumerator.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/StringRuneEnumerator.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/SpanRuneEnumerator.xml Co-Authored-By: Maira Wenzel <[email protected]> * Update xml/System.Text/StringRuneEnumerator.xml Co-Authored-By: Maira Wenzel <[email protected]> * Apply suggestions from code review Co-Authored-By: Carlos Sanchez Lopez <[email protected]> Co-Authored-By: Maira Wenzel <[email protected]> * added EII remarks
1 parent 2053bbd commit d2cd895

File tree

2 files changed

+87
-37
lines changed

2 files changed

+87
-37
lines changed

‎xml/System.Text/SpanRuneEnumerator.xml

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,18 @@
1919
</Attribute>
2020
</Attributes>
2121
<Docs>
22-
<summary>To be added.</summary>
23-
<remarks>To be added.</remarks>
22+
<summary>Provides an enumerator for the <see cref="T:System.Text.Rune" /> values represented by a span containing UTF-16 text.</summary>
23+
<remarks>
24+
<format type="text/markdown"><![CDATA[
25+
26+
## Remarks
27+
28+
This type is not intended to be referenced directly by application code. Instead, use the <xref:System.MemoryExtensions.EnumerateRunes%2A> method along with language-specific enumeration constructs to enumerate <xref:System.Text.Rune> values within spans.
29+
30+
The `foreach` statement of the C# language (`for each` in C++, `For Each` in Visual Basic) hides the complexity of enumerators. Therefore, using `foreach` is recommended, instead of directly manipulating the enumerator.
31+
32+
]]></format>
33+
</remarks>
2434
</Docs>
2535
<Members>
2636
<Member MemberName="Current">
@@ -39,9 +49,8 @@
3949
<ReturnType>System.Text.Rune</ReturnType>
4050
</ReturnValue>
4151
<Docs>
42-
<summary>To be added.</summary>
43-
<value>To be added.</value>
44-
<remarks>To be added.</remarks>
52+
<summary>Gets the <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</summary>
53+
<value>The <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</value>
4554
</Docs>
4655
</Member>
4756
<Member MemberName="GetEnumerator">
@@ -61,9 +70,8 @@
6170
</ReturnValue>
6271
<Parameters />
6372
<Docs>
64-
<summary>To be added.</summary>
65-
<returns>To be added.</returns>
66-
<remarks>To be added.</remarks>
73+
<summary>Returns the current enumerator instance.</summary>
74+
<returns>The current enumerator instance.</returns>
6775
</Docs>
6876
</Member>
6977
<Member MemberName="MoveNext">
@@ -83,10 +91,9 @@
8391
</ReturnValue>
8492
<Parameters />
8593
<Docs>
86-
<summary>To be added.</summary>
87-
<returns>To be added.</returns>
88-
<remarks>To be added.</remarks>
94+
<summary>Advances the enumerator to the next <see cref="T:System.Text.Rune" /> of the span.</summary>
95+
<returns><see langword="true" /> if the enumerator successfully advanced to the next item; <see langword="false" /> if the end of the span has been reached.</returns>
8996
</Docs>
9097
</Member>
9198
</Members>
92-
</Type>
99+
</Type>

‎xml/System.Text/StringRuneEnumerator.xml

Lines changed: 68 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,18 @@
3030
</Interface>
3131
</Interfaces>
3232
<Docs>
33-
<summary>To be added.</summary>
34-
<remarks>To be added.</remarks>
33+
<summary>Provides an enumerator for the <see cref="T:System.Text.Rune" /> values represented by a string.</summary>
34+
<remarks>
35+
<format type="text/markdown"><![CDATA[
36+
37+
## Remarks
38+
39+
This type is not intended to be referenced directly by application code. Instead, use the <xref:System.String.EnumerateRunes> method along with language-specific enumeration constructs to enumerate <xref:System.Text.Rune> values within strings.
40+
41+
The `foreach` statement of the C# language (`for each` in C++, `For Each` in Visual Basic) hides the complexity of enumerators. Therefore, using `foreach` is recommended, instead of directly manipulating the enumerator.
42+
43+
]]></format>
44+
</remarks>
3545
</Docs>
3646
<Members>
3747
<Member MemberName="Current">
@@ -53,9 +63,8 @@
5363
<ReturnType>System.Text.Rune</ReturnType>
5464
</ReturnValue>
5565
<Docs>
56-
<summary>To be added.</summary>
57-
<value>To be added.</value>
58-
<remarks>To be added.</remarks>
66+
<summary>Gets the <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</summary>
67+
<value>The <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</value>
5968
</Docs>
6069
</Member>
6170
<Member MemberName="GetEnumerator">
@@ -75,9 +84,8 @@
7584
</ReturnValue>
7685
<Parameters />
7786
<Docs>
78-
<summary>To be added.</summary>
79-
<returns>To be added.</returns>
80-
<remarks>To be added.</remarks>
87+
<summary>Returns the current enumerator instance.</summary>
88+
<returns>The current enumerator instance.</returns>
8189
</Docs>
8290
</Member>
8391
<Member MemberName="MoveNext">
@@ -100,9 +108,8 @@
100108
</ReturnValue>
101109
<Parameters />
102110
<Docs>
103-
<summary>To be added.</summary>
104-
<returns>To be added.</returns>
105-
<remarks>To be added.</remarks>
111+
<summary>Advances the enumerator to the next <see cref="T:System.Text.Rune" /> of the string.</summary>
112+
<returns><see langword="true" /> if the enumerator successfully advanced to the next item; <see langword="false" /> if the end of the string has been reached.</returns>
106113
</Docs>
107114
</Member>
108115
<Member MemberName="System.Collections.Generic.IEnumerable&lt;System.Text.Rune&gt;.GetEnumerator">
@@ -124,9 +131,18 @@
124131
</ReturnValue>
125132
<Parameters />
126133
<Docs>
127-
<summary>To be added.</summary>
128-
<returns>To be added.</returns>
129-
<remarks>To be added.</remarks>
134+
<summary>Returns the current enumerator instance.</summary>
135+
<returns>The current enumerator instance.</returns>
136+
<remarks>
137+
<format type="text/markdown"><![CDATA[
138+
139+
## Remarks
140+
141+
This member is an explicit interface member implementation.
142+
It can be used only when the <xref:System.Text.StringRuneEnumerator> instance is cast to an <xref:System.Collections.Generic.IEnumerable%601> interface.
143+
144+
]]></format>
145+
</remarks>
130146
</Docs>
131147
</Member>
132148
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
@@ -148,9 +164,18 @@
148164
</ReturnValue>
149165
<Parameters />
150166
<Docs>
151-
<summary>To be added.</summary>
152-
<returns>To be added.</returns>
153-
<remarks>To be added.</remarks>
167+
<summary>Returns the current enumerator instance.</summary>
168+
<returns>The current enumerator instance.</returns>
169+
<remarks>
170+
<format type="text/markdown"><![CDATA[
171+
172+
## Remarks
173+
174+
This member is an explicit interface member implementation.
175+
It can be used only when the <xref:System.Text.StringRuneEnumerator> instance is cast to an <xref:System.Collections.IEnumerable> interface.
176+
177+
]]></format>
178+
</remarks>
154179
</Docs>
155180
</Member>
156181
<Member MemberName="System.Collections.IEnumerator.Current">
@@ -172,9 +197,18 @@
172197
<ReturnType>System.Object</ReturnType>
173198
</ReturnValue>
174199
<Docs>
175-
<summary>To be added.</summary>
176-
<value>To be added.</value>
177-
<remarks>To be added.</remarks>
200+
<summary>Gets the <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</summary>
201+
<value>The <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</value>
202+
<remarks>
203+
<format type="text/markdown"><![CDATA[
204+
205+
## Remarks
206+
207+
This member is an explicit interface member implementation.
208+
It can be used only when the <xref:System.Text.StringRuneEnumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.
209+
210+
]]></format>
211+
</remarks>
178212
</Docs>
179213
</Member>
180214
<Member MemberName="System.Collections.IEnumerator.Reset">
@@ -196,8 +230,17 @@
196230
</ReturnValue>
197231
<Parameters />
198232
<Docs>
199-
<summary>To be added.</summary>
200-
<remarks>To be added.</remarks>
233+
<summary>Resets the current <see cref="T:System.Text.StringRuneEnumerator" /> instance to the beginning of the string.</summary>
234+
<remarks>
235+
<format type="text/markdown"><![CDATA[
236+
237+
## Remarks
238+
239+
This member is an explicit interface member implementation.
240+
It can be used only when the <xref:System.Text.StringRuneEnumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.
241+
242+
]]></format>
243+
</remarks>
201244
</Docs>
202245
</Member>
203246
<Member MemberName="System.IDisposable.Dispose">
@@ -219,9 +262,9 @@
219262
</ReturnValue>
220263
<Parameters />
221264
<Docs>
222-
<summary>To be added.</summary>
223-
<remarks>To be added.</remarks>
265+
<summary>Releases all resources used by the current <see cref="T:System.Text.StringRuneEnumerator" /> instance.</summary>
266+
<remarks>This method performs no operation and produces no side effects.</remarks>
224267
</Docs>
225268
</Member>
226269
</Members>
227-
</Type>
270+
</Type>

0 commit comments

Comments
 (0)