Skip to content

Initial docs for StringRuneEnumerator and SpanRuneEnumerator #2821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 6, 2019
Merged

Initial docs for StringRuneEnumerator and SpanRuneEnumerator #2821

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c1d62d0
Initial docs for StringRuneEnumerator and SpanRuneEnumerator
GrabYourPitchforks Jul 24, 2019
4bf976a
Update xml/System.Text/SpanRuneEnumerator.xml
GrabYourPitchforks Jul 30, 2019
2d655c6
Update xml/System.Text/StringRuneEnumerator.xml
GrabYourPitchforks Jul 30, 2019
b6ea483
Update xml/System.Text/SpanRuneEnumerator.xml
GrabYourPitchforks Jul 30, 2019
a829ce3
Update xml/System.Text/StringRuneEnumerator.xml
GrabYourPitchforks Jul 30, 2019
e25fb0c
Apply suggestions from code review
GrabYourPitchforks Jul 30, 2019
04a006c
added EII remarks
mairaw Aug 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 19 additions & 12 deletions xml/System.Text/SpanRuneEnumerator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,18 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Provides an enumerator for the <see cref="T:System.Text.Rune" /> values represented by a span containing UTF-16 text.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

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.

]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="Current">
Expand All @@ -39,9 +49,8 @@
<ReturnType>System.Text.Rune</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</summary>
<value>The <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</value>
</Docs>
</Member>
<Member MemberName="GetEnumerator">
Expand All @@ -61,9 +70,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Returns the current enumerator instance.</summary>
<returns>The current enumerator instance.</returns>
</Docs>
</Member>
<Member MemberName="MoveNext">
Expand All @@ -83,10 +91,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Advances the enumerator to the next <see cref="T:System.Text.Rune" /> of the span.</summary>
<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>
</Docs>
</Member>
</Members>
</Type>
</Type>
93 changes: 68 additions & 25 deletions xml/System.Text/StringRuneEnumerator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,18 @@
</Interface>
</Interfaces>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Provides an enumerator for the <see cref="T:System.Text.Rune" /> values represented by a string.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

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.

]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="Current">
Expand All @@ -53,9 +63,8 @@
<ReturnType>System.Text.Rune</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</summary>
<value>The <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</value>
</Docs>
</Member>
<Member MemberName="GetEnumerator">
Expand All @@ -75,9 +84,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Returns the current enumerator instance.</summary>
<returns>The current enumerator instance.</returns>
</Docs>
</Member>
<Member MemberName="MoveNext">
Expand All @@ -100,9 +108,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Advances the enumerator to the next <see cref="T:System.Text.Rune" /> of the string.</summary>
<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>
</Docs>
</Member>
<Member MemberName="System.Collections.Generic.IEnumerable&lt;System.Text.Rune&gt;.GetEnumerator">
Expand All @@ -124,9 +131,18 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Returns the current enumerator instance.</summary>
<returns>The current enumerator instance.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation.
It can be used only when the <xref:System.Text.StringRuneEnumerator> instance is cast to an <xref:System.Collections.Generic.IEnumerable%601> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
Expand All @@ -148,9 +164,18 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Returns the current enumerator instance.</summary>
<returns>The current enumerator instance.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation.
It can be used only when the <xref:System.Text.StringRuneEnumerator> instance is cast to an <xref:System.Collections.IEnumerable> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerator.Current">
Expand All @@ -172,9 +197,18 @@
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</summary>
<value>The <see cref="T:System.Text.Rune" /> at the current position of the enumerator.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation.
It can be used only when the <xref:System.Text.StringRuneEnumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerator.Reset">
Expand All @@ -196,8 +230,17 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Resets the current <see cref="T:System.Text.StringRuneEnumerator" /> instance to the beginning of the string.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation.
It can be used only when the <xref:System.Text.StringRuneEnumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.IDisposable.Dispose">
Expand All @@ -219,9 +262,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Releases all resources used by the current <see cref="T:System.Text.StringRuneEnumerator" /> instance.</summary>
<remarks>This method performs no operation and produces no side effects.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>