From c1d62d07182b05b61efa10dcf9c27c2a0ff86683 Mon Sep 17 00:00:00 2001 From: Levi Broderick Date: Wed, 24 Jul 2019 14:13:16 -0700 Subject: [PATCH 1/7] Initial docs for StringRuneEnumerator and SpanRuneEnumerator --- xml/System.Text/SpanRuneEnumerator.xml | 27 +++++++------ xml/System.Text/StringRuneEnumerator.xml | 49 ++++++++++++------------ 2 files changed, 41 insertions(+), 35 deletions(-) diff --git a/xml/System.Text/SpanRuneEnumerator.xml b/xml/System.Text/SpanRuneEnumerator.xml index 5a807ec8c1a..3602731a7ab 100644 --- a/xml/System.Text/SpanRuneEnumerator.xml +++ b/xml/System.Text/SpanRuneEnumerator.xml @@ -19,8 +19,16 @@ - To be added. - To be added. + Provides an enumerator for the values represented by a span containing UTF-16 text. + + method along with language-specific enumeration constructs to enumerate values within spans. + +The C# [foreach](~/docs/csharp/language-reference/keywords/foreach-in.md) of the C# language and the [For Each...Next](~/docs/visual-basic/language-reference/statements/for-each-next-statement.md) construct in Visual Basic hides the complexity of enumerators. Instead of directly manipulating the enumerator, using `foreach` or `For Each...Next` is recommended. + + ]]> + @@ -39,9 +47,8 @@ System.Text.Rune - To be added. - To be added. - To be added. + Gets the at the current position of the enumerator. + The at the current position of the enumerator. @@ -61,9 +68,8 @@ - To be added. - To be added. - To be added. + Returns the current enumerator instance. + The current enumerator instance. @@ -83,9 +89,8 @@ - To be added. - To be added. - To be added. + Advances the enumerator to the next of the span. + `true` if the enumerator successfully advanced to the next item; `false` if the end of the span has been reached. diff --git a/xml/System.Text/StringRuneEnumerator.xml b/xml/System.Text/StringRuneEnumerator.xml index 6f673b59ab5..669e12e6971 100644 --- a/xml/System.Text/StringRuneEnumerator.xml +++ b/xml/System.Text/StringRuneEnumerator.xml @@ -30,8 +30,16 @@ - To be added. - To be added. + Provides an enumerator for the values represented by a . + + method along with language-specific enumeration constructs to enumerate values within strings. + +The C# [foreach](~/docs/csharp/language-reference/keywords/foreach-in.md) of the C# language and the [For Each...Next](~/docs/visual-basic/language-reference/statements/for-each-next-statement.md) construct in Visual Basic hides the complexity of enumerators. Instead of directly manipulating the enumerator, using `foreach` or `For Each...Next` is recommended. + + ]]> + @@ -53,9 +61,8 @@ System.Text.Rune - To be added. - To be added. - To be added. + Gets the at the current position of the enumerator. + The at the current position of the enumerator. @@ -75,9 +82,8 @@ - To be added. - To be added. - To be added. + Returns the current enumerator instance. + The current enumerator instance. @@ -100,9 +106,8 @@ - To be added. - To be added. - To be added. + Advances the enumerator to the next of the string. + `true` if the enumerator successfully advanced to the next item; `false` if the end of the string has been reached. @@ -124,9 +129,8 @@ - To be added. - To be added. - To be added. + Returns the current enumerator instance. + The current enumerator instance. @@ -148,9 +152,8 @@ - To be added. - To be added. - To be added. + Returns the current enumerator instance. + The current enumerator instance. @@ -172,9 +175,8 @@ System.Object - To be added. - To be added. - To be added. + Gets the at the current position of the enumerator. + The at the current position of the enumerator. @@ -196,8 +198,7 @@ - To be added. - To be added. + Resets the current instance to the beginning of the string. @@ -219,8 +220,8 @@ - To be added. - To be added. + Releases all resources used by the current instance. + This method performs no operation and produces no side effects. From 4bf976afdca56e21da6ee8624d62776bd621da8b Mon Sep 17 00:00:00 2001 From: Levi Broderick Date: Tue, 30 Jul 2019 16:23:52 -0700 Subject: [PATCH 2/7] Update xml/System.Text/SpanRuneEnumerator.xml Co-Authored-By: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Text/SpanRuneEnumerator.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Text/SpanRuneEnumerator.xml b/xml/System.Text/SpanRuneEnumerator.xml index 3602731a7ab..b109bcb67e7 100644 --- a/xml/System.Text/SpanRuneEnumerator.xml +++ b/xml/System.Text/SpanRuneEnumerator.xml @@ -90,8 +90,8 @@ The C# [foreach](~/docs/csharp/language-reference/keywords/foreach-in.md) of the Advances the enumerator to the next of the span. - `true` if the enumerator successfully advanced to the next item; `false` if the end of the span has been reached. + if the enumerator successfully advanced to the next item; if the end of the span has been reached. - \ No newline at end of file + From 2d655c63037645c3970c2cb0bd216aa3eb045698 Mon Sep 17 00:00:00 2001 From: Levi Broderick Date: Tue, 30 Jul 2019 16:24:00 -0700 Subject: [PATCH 3/7] Update xml/System.Text/StringRuneEnumerator.xml Co-Authored-By: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> --- xml/System.Text/StringRuneEnumerator.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Text/StringRuneEnumerator.xml b/xml/System.Text/StringRuneEnumerator.xml index 669e12e6971..0e58638b969 100644 --- a/xml/System.Text/StringRuneEnumerator.xml +++ b/xml/System.Text/StringRuneEnumerator.xml @@ -107,7 +107,7 @@ The C# [foreach](~/docs/csharp/language-reference/keywords/foreach-in.md) of the Advances the enumerator to the next of the string. - `true` if the enumerator successfully advanced to the next item; `false` if the end of the string has been reached. + if the enumerator successfully advanced to the next item; if the end of the string has been reached. @@ -225,4 +225,4 @@ The C# [foreach](~/docs/csharp/language-reference/keywords/foreach-in.md) of the - \ No newline at end of file + From b6ea48380ca540ab3373d22180a1a688ecb94995 Mon Sep 17 00:00:00 2001 From: Levi Broderick Date: Tue, 30 Jul 2019 16:25:09 -0700 Subject: [PATCH 4/7] Update xml/System.Text/SpanRuneEnumerator.xml Co-Authored-By: Maira Wenzel --- xml/System.Text/SpanRuneEnumerator.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Text/SpanRuneEnumerator.xml b/xml/System.Text/SpanRuneEnumerator.xml index b109bcb67e7..8aab64b2d2e 100644 --- a/xml/System.Text/SpanRuneEnumerator.xml +++ b/xml/System.Text/SpanRuneEnumerator.xml @@ -25,7 +25,7 @@ This type is not intended to be referenced directly by application code. Instead, use the method along with language-specific enumeration constructs to enumerate values within spans. -The C# [foreach](~/docs/csharp/language-reference/keywords/foreach-in.md) of the C# language and the [For Each...Next](~/docs/visual-basic/language-reference/statements/for-each-next-statement.md) construct in Visual Basic hides the complexity of enumerators. Instead of directly manipulating the enumerator, using `foreach` or `For Each...Next` is recommended. +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. ]]> From a829ce38767db01ba1c57235bfc8b3477be9c8a6 Mon Sep 17 00:00:00 2001 From: Levi Broderick Date: Tue, 30 Jul 2019 16:25:23 -0700 Subject: [PATCH 5/7] Update xml/System.Text/StringRuneEnumerator.xml Co-Authored-By: Maira Wenzel --- xml/System.Text/StringRuneEnumerator.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Text/StringRuneEnumerator.xml b/xml/System.Text/StringRuneEnumerator.xml index 0e58638b969..88af74500f3 100644 --- a/xml/System.Text/StringRuneEnumerator.xml +++ b/xml/System.Text/StringRuneEnumerator.xml @@ -30,7 +30,7 @@ - Provides an enumerator for the values represented by a . + Provides an enumerator for the values represented by a string. Date: Tue, 30 Jul 2019 16:27:22 -0700 Subject: [PATCH 6/7] Apply suggestions from code review Co-Authored-By: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Co-Authored-By: Maira Wenzel --- xml/System.Text/SpanRuneEnumerator.xml | 4 +++- xml/System.Text/StringRuneEnumerator.xml | 6 +++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/xml/System.Text/SpanRuneEnumerator.xml b/xml/System.Text/SpanRuneEnumerator.xml index 8aab64b2d2e..d76da978f47 100644 --- a/xml/System.Text/SpanRuneEnumerator.xml +++ b/xml/System.Text/SpanRuneEnumerator.xml @@ -23,7 +23,9 @@ method along with language-specific enumeration constructs to enumerate values within spans. +## Remarks + +This type is not intended to be referenced directly by application code. Instead, use the method along with language-specific enumeration constructs to enumerate 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. diff --git a/xml/System.Text/StringRuneEnumerator.xml b/xml/System.Text/StringRuneEnumerator.xml index 88af74500f3..94ef94e2995 100644 --- a/xml/System.Text/StringRuneEnumerator.xml +++ b/xml/System.Text/StringRuneEnumerator.xml @@ -34,9 +34,11 @@ method along with language-specific enumeration constructs to enumerate values within strings. -The C# [foreach](~/docs/csharp/language-reference/keywords/foreach-in.md) of the C# language and the [For Each...Next](~/docs/visual-basic/language-reference/statements/for-each-next-statement.md) construct in Visual Basic hides the complexity of enumerators. Instead of directly manipulating the enumerator, using `foreach` or `For Each...Next` is recommended. +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. ]]> @@ -131,6 +133,7 @@ The C# [foreach](~/docs/csharp/language-reference/keywords/foreach-in.md) of the Returns the current enumerator instance. The current enumerator instance. + To be added. @@ -154,6 +157,7 @@ The C# [foreach](~/docs/csharp/language-reference/keywords/foreach-in.md) of the Returns the current enumerator instance. The current enumerator instance. + To be added. From 04a006ca1f0cb51fe882d363151096e5d4b9f2aa Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Mon, 5 Aug 2019 18:41:22 -0700 Subject: [PATCH 7/7] added EII remarks --- xml/System.Text/StringRuneEnumerator.xml | 42 ++++++++++++++++++++++-- 1 file changed, 40 insertions(+), 2 deletions(-) diff --git a/xml/System.Text/StringRuneEnumerator.xml b/xml/System.Text/StringRuneEnumerator.xml index 94ef94e2995..d18c0395440 100644 --- a/xml/System.Text/StringRuneEnumerator.xml +++ b/xml/System.Text/StringRuneEnumerator.xml @@ -133,7 +133,16 @@ The `foreach` statement of the C# language (`for each` in C++, `For Each` in Vis Returns the current enumerator instance. The current enumerator instance. - To be added. + + instance is cast to an interface. + + ]]> + @@ -157,7 +166,16 @@ The `foreach` statement of the C# language (`for each` in C++, `For Each` in Vis Returns the current enumerator instance. The current enumerator instance. - To be added. + + instance is cast to an interface. + + ]]> + @@ -181,6 +199,16 @@ The `foreach` statement of the C# language (`for each` in C++, `For Each` in Vis Gets the at the current position of the enumerator. The at the current position of the enumerator. + + instance is cast to an interface. + + ]]> + @@ -203,6 +231,16 @@ The `foreach` statement of the C# language (`for each` in C++, `For Each` in Vis Resets the current instance to the beginning of the string. + + instance is cast to an interface. + + ]]> +