Skip to content

Commit 3651464

Browse files
jozkeecarlossanlop
authored and
Ron Petrusha
committed
Added documentation for System.Text.Rune struct (#2943)
* Added docuemntation for System.Text.Rune struct. * Apply suggestions from code review Co-Authored-By: Carlos Sanchez Lopez <[email protected]>
1 parent 95bc292 commit 3651464

File tree

1 file changed

+54
-51
lines changed

1 file changed

+54
-51
lines changed

‎xml/System.Text/Rune.xml

Lines changed: 54 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -951,10 +951,10 @@ This method is very similar to <xref:System.Text.Rune.DecodeFromUtf8(System.Read
951951
<Parameter Name="right" Type="System.Text.Rune" />
952952
</Parameters>
953953
<Docs>
954-
<param name="left">To be added.</param>
955-
<param name="right">To be added.</param>
956-
<summary>To be added.</summary>
957-
<returns>To be added.</returns>
954+
<param name="left">The first value to compare.</param>
955+
<param name="right">The second value to compare.</param>
956+
<summary>Returns a value that indicates whether two <see cref="T:System.Text.Rune"/> instances are equal.</summary>
957+
<returns><see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are equal; otherwise, <see langword="false" />.</returns>
958958
<remarks>To be added.</remarks>
959959
</Docs>
960960
</Member>
@@ -977,10 +977,11 @@ This method is very similar to <xref:System.Text.Rune.DecodeFromUtf8(System.Read
977977
<Parameter Name="ch" Type="System.Char" />
978978
</Parameters>
979979
<Docs>
980-
<param name="ch">To be added.</param>
981-
<summary>To be added.</summary>
982-
<returns>To be added.</returns>
983-
<remarks>To be added.</remarks>
980+
<param name="ch">The 16-bit Unicode character to convert.</param>
981+
<summary>Defines an explicit conversion of a 16-bit Unicode character to a <see cref="T:System.Text.Rune"/>.</summary>
982+
<returns><paramref name="ch" /> as a 32-bit Unicode character.</returns>
983+
<remarks>To be added.</remarks>
984+
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="ch" /> is a Unicode scalar that represents a surrogate code point.</exception>
984985
</Docs>
985986
</Member>
986987
<Member MemberName="op_Explicit">
@@ -1002,10 +1003,11 @@ This method is very similar to <xref:System.Text.Rune.DecodeFromUtf8(System.Read
10021003
<Parameter Name="value" Type="System.Int32" />
10031004
</Parameters>
10041005
<Docs>
1005-
<param name="value">To be added.</param>
1006-
<summary>To be added.</summary>
1007-
<returns>To be added.</returns>
1008-
<remarks>To be added.</remarks>
1006+
<param name="value">The 32-bit signed integer to convert.</param>
1007+
<summary>Defines an explicit conversion of a 32-bit signed integer to a <see cref="T:System.Text.Rune"/>.</summary>
1008+
<returns><paramref name="value" /> as a 32-bit Unicode character.</returns>
1009+
<remarks>To be added.</remarks>
1010+
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value" /> is an invalid Unicode scalar.</exception>
10091011
</Docs>
10101012
</Member>
10111013
<Member MemberName="op_Explicit">
@@ -1032,10 +1034,11 @@ This method is very similar to <xref:System.Text.Rune.DecodeFromUtf8(System.Read
10321034
<Parameter Name="value" Type="System.UInt32" />
10331035
</Parameters>
10341036
<Docs>
1035-
<param name="value">To be added.</param>
1036-
<summary>To be added.</summary>
1037-
<returns>To be added.</returns>
1038-
<remarks>To be added.</remarks>
1037+
<param name="value">The 32-bit signed integer to convert.</param>
1038+
<summary>Defines an explicit conversion of a 32-bit unsigned integer to a <see cref="T:System.Text.Rune"/>.</summary>
1039+
<returns><paramref name="value" /> as a 32-bit Unicode character.</returns>
1040+
<remarks>To be added.</remarks>
1041+
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value" /> is an invalid Unicode scalar.</exception>
10391042
</Docs>
10401043
</Member>
10411044
<Member MemberName="op_GreaterThan">
@@ -1058,10 +1061,10 @@ This method is very similar to <xref:System.Text.Rune.DecodeFromUtf8(System.Read
10581061
<Parameter Name="right" Type="System.Text.Rune" />
10591062
</Parameters>
10601063
<Docs>
1061-
<param name="left">To be added.</param>
1062-
<param name="right">To be added.</param>
1063-
<summary>To be added.</summary>
1064-
<returns>To be added.</returns>
1064+
<param name="left">The first value to compare.</param>
1065+
<param name="right">The second value to compare.</param>
1066+
<summary>Returns a value indicating whether a specified <see cref="T:System.Text.Rune"/> is greater than another specified <see cref="T:System.Text.Rune"/>.</summary>
1067+
<returns><see langword="true" /> if <paramref name="left" /> is greater than <paramref name="right" />; otherwise, <see langword="false" />.</returns>
10651068
<remarks>To be added.</remarks>
10661069
</Docs>
10671070
</Member>
@@ -1085,10 +1088,10 @@ This method is very similar to <xref:System.Text.Rune.DecodeFromUtf8(System.Read
10851088
<Parameter Name="right" Type="System.Text.Rune" />
10861089
</Parameters>
10871090
<Docs>
1088-
<param name="left">To be added.</param>
1089-
<param name="right">To be added.</param>
1090-
<summary>To be added.</summary>
1091-
<returns>To be added.</returns>
1091+
<param name="left">The first value to compare.</param>
1092+
<param name="right">The second value to compare.</param>
1093+
<summary>Returns a value indicating whether a specified <see cref="T:System.Text.Rune"/> is greater than or equal to another specified <see cref="T:System.Text.Rune"/>.</summary>
1094+
<returns><see langword="true" /> if <paramref name="left" /> is greater than or equal to <paramref name="right" />; otherwise, <see langword="false" />.</returns>
10921095
<remarks>To be added.</remarks>
10931096
</Docs>
10941097
</Member>
@@ -1112,10 +1115,10 @@ This method is very similar to <xref:System.Text.Rune.DecodeFromUtf8(System.Read
11121115
<Parameter Name="right" Type="System.Text.Rune" />
11131116
</Parameters>
11141117
<Docs>
1115-
<param name="left">To be added.</param>
1116-
<param name="right">To be added.</param>
1117-
<summary>To be added.</summary>
1118-
<returns>To be added.</returns>
1118+
<param name="left">The first value to compare.</param>
1119+
<param name="right">The second value to compare.</param>
1120+
<summary>Returns a value that indicates whether two <see cref="T:System.Text.Rune"/> instances have different values.</summary>
1121+
<returns><see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are not equal; otherwise, <see langword="false" />.</returns>
11191122
<remarks>To be added.</remarks>
11201123
</Docs>
11211124
</Member>
@@ -1139,10 +1142,10 @@ This method is very similar to <xref:System.Text.Rune.DecodeFromUtf8(System.Read
11391142
<Parameter Name="right" Type="System.Text.Rune" />
11401143
</Parameters>
11411144
<Docs>
1142-
<param name="left">To be added.</param>
1143-
<param name="right">To be added.</param>
1144-
<summary>To be added.</summary>
1145-
<returns>To be added.</returns>
1145+
<param name="left">The first value to compare.</param>
1146+
<param name="right">the second value to compare.</param>
1147+
<summary>Returns a value indicating whether a specified <see cref="T:System.Text.Rune"/> is less than another specified <see cref="T:System.Text.Rune"/>.</summary>
1148+
<returns><see langword="true" /> if <paramref name="left" /> is less than <paramref name="right" />; otherwise, <see langword="false" />.</returns>
11461149
<remarks>To be added.</remarks>
11471150
</Docs>
11481151
</Member>
@@ -1166,10 +1169,10 @@ This method is very similar to <xref:System.Text.Rune.DecodeFromUtf8(System.Read
11661169
<Parameter Name="right" Type="System.Text.Rune" />
11671170
</Parameters>
11681171
<Docs>
1169-
<param name="left">To be added.</param>
1170-
<param name="right">To be added.</param>
1171-
<summary>To be added.</summary>
1172-
<returns>To be added.</returns>
1172+
<param name="left">The first value to compare.</param>
1173+
<param name="right">The second value to compare.</param>
1174+
<summary>Returns a value indicating whether a specified <see cref="T:System.Text.Rune"/> is less than or equal to another specified <see cref="T:System.Text.Rune"/>.</summary>
1175+
<returns><see langword="true" /> if <paramref name="left" /> is less than or equal to <paramref name="right" />; otherwise, <see langword="false" />.</returns>
11731176
<remarks>To be added.</remarks>
11741177
</Docs>
11751178
</Member>
@@ -1235,10 +1238,10 @@ This method is very similar to <xref:System.Text.Rune.DecodeFromUtf8(System.Read
12351238
<Parameter Name="culture" Type="System.Globalization.CultureInfo" />
12361239
</Parameters>
12371240
<Docs>
1238-
<param name="value">To be added.</param>
1239-
<param name="culture">To be added.</param>
1240-
<summary>To be added.</summary>
1241-
<returns>To be added.</returns>
1241+
<param name="value">The 32-bit Unicode character to convert.</param>
1242+
<param name="culture">An object that supplies culture-specific casing rules.</param>
1243+
<summary>Returns a copy of the specified <see cref="T:System.Text.Rune"/> converted to lowercase, using the casing rules of the specified culture.</summary>
1244+
<returns>The lowercase equivalent of <paramref name="value" />.</returns>
12421245
<remarks>To be added.</remarks>
12431246
</Docs>
12441247
</Member>
@@ -1261,9 +1264,9 @@ This method is very similar to <xref:System.Text.Rune.DecodeFromUtf8(System.Read
12611264
<Parameter Name="value" Type="System.Text.Rune" />
12621265
</Parameters>
12631266
<Docs>
1264-
<param name="value">To be added.</param>
1265-
<summary>To be added.</summary>
1266-
<returns>To be added.</returns>
1267+
<param name="value">The 32-bit Unicode character to convert.</param>
1268+
<summary>Returns a copy of the specified <see cref="T:System.Text.Rune"/> converted to lowercase using the casing rules of the invariant culture.</summary>
1269+
<returns>The lowercase equivalent of <paramref name="value" />.</returns>
12671270
<remarks>To be added.</remarks>
12681271
</Docs>
12691272
</Member>
@@ -1309,10 +1312,10 @@ This method is very similar to <xref:System.Text.Rune.DecodeFromUtf8(System.Read
13091312
<Parameter Name="culture" Type="System.Globalization.CultureInfo" />
13101313
</Parameters>
13111314
<Docs>
1312-
<param name="value">To be added.</param>
1313-
<param name="culture">To be added.</param>
1314-
<summary>To be added.</summary>
1315-
<returns>To be added.</returns>
1315+
<param name="value">The 32-bit Unicode character to convert.</param>
1316+
<param name="culture">An object that supplies culture-specific casing rules.</param>
1317+
<summary>Returns a copy of the specified <see cref="T:System.Text.Rune"/> converted to uppercase, using the casing rules of the specified culture.</summary>
1318+
<returns>The uppercase equivalent of <paramref name="value" />.</returns>
13161319
<remarks>To be added.</remarks>
13171320
</Docs>
13181321
</Member>
@@ -1335,9 +1338,9 @@ This method is very similar to <xref:System.Text.Rune.DecodeFromUtf8(System.Read
13351338
<Parameter Name="value" Type="System.Text.Rune" />
13361339
</Parameters>
13371340
<Docs>
1338-
<param name="value">To be added.</param>
1339-
<summary>To be added.</summary>
1340-
<returns>To be added.</returns>
1341+
<param name="value">The 32-bit Unicode character to convert.</param>
1342+
<summary>Returns a copy of the specified <see cref="T:System.Text.Rune"/> converted to uppercase using the casing rules of the invariant culture.</summary>
1343+
<returns>The uppercase equivalent of <paramref name="value" />.</returns>
13411344
<remarks>To be added.</remarks>
13421345
</Docs>
13431346
</Member>
@@ -1654,4 +1657,4 @@ The return value will be 1 through 4, inclusive.
16541657
</Docs>
16551658
</Member>
16561659
</Members>
1657-
</Type>
1660+
</Type>

0 commit comments

Comments
 (0)