Skip to content

Commit ce7fbe3

Browse files
nxtnnxtn
authored
Replace <see langword="Single" /> tags (#3991)
* Replace <see langword="Single" /> tags * Don't list all enum values * Use <code> for XAML types * Fix enum field reference * Revert VB keywords
1 parent 8e2f3c9 commit ce7fbe3

File tree

17 files changed

+53
-53
lines changed

17 files changed

+53
-53
lines changed

‎xml/Microsoft.VisualBasic.Compatibility.VB6/Support.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -631,7 +631,7 @@
631631
</Parameters>
632632
<Docs>
633633
<param name="CurrentFont">A <see cref="T:System.Drawing.Font" />.</param>
634-
<param name="Size">A <see langword="Single" /> that represents the Visual Basic 6.0 <see langword="FontSize" /> property.</param>
634+
<param name="Size">A <see cref="T:System.Single" /> that represents the Visual Basic 6.0 <see langword="FontSize" /> property.</param>
635635
<summary>Changes the <see cref="P:System.Drawing.Font.Size" /> property for a font.</summary>
636636
<returns>A <see cref="T:System.Drawing.Font" /> that matches the Visual Basic 6.0 <see langword="FontSize" />.</returns>
637637
<remarks>

‎xml/Microsoft.VisualBasic.CompilerServices/Conversions.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1160,7 +1160,7 @@
11601160
<Docs>
11611161
<param name="Value">The object to convert.</param>
11621162
<summary>Converts an object to a <see cref="T:System.Single" /> value.</summary>
1163-
<returns>The <see langword="Single" /> value of the object.</returns>
1163+
<returns>The <see cref="T:System.Single" /> value of the object.</returns>
11641164
<remarks>To be added.</remarks>
11651165
</Docs>
11661166
</Member>
@@ -1197,7 +1197,7 @@
11971197
<Docs>
11981198
<param name="Value">The string to convert.</param>
11991199
<summary>Converts a <see cref="T:System.String" /> to a <see cref="T:System.Single" /> value.</summary>
1200-
<returns>The <see langword="Single" /> value of the string.</returns>
1200+
<returns>The <see cref="T:System.Single" /> value of the string.</returns>
12011201
<remarks>To be added.</remarks>
12021202
</Docs>
12031203
</Member>
@@ -1571,9 +1571,9 @@
15711571
<Parameter Name="Value" Type="System.Single" />
15721572
</Parameters>
15731573
<Docs>
1574-
<param name="Value">The <see langword="Single" /> value to convert.</param>
1574+
<param name="Value">The <see cref="T:System.Single" /> value to convert.</param>
15751575
<summary>Converts a <see cref="T:System.Single" /> value (a single-precision floating point number) to a <see cref="T:System.String" /> value.</summary>
1576-
<returns>The <see langword="String" /> representation of the <see langword="Single" /> value.</returns>
1576+
<returns>The string representation of the <see cref="T:System.Single" /> value.</returns>
15771577
<remarks>To be added.</remarks>
15781578
</Docs>
15791579
</Member>
@@ -1748,10 +1748,10 @@
17481748
<Parameter Name="NumberFormat" Type="System.Globalization.NumberFormatInfo" Index="1" FrameworkAlternate="netcore-3.0;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netcore-3.1" />
17491749
</Parameters>
17501750
<Docs>
1751-
<param name="Value">The <see langword="Single" /> value to convert.</param>
1751+
<param name="Value">The <see cref="T:System.Single" /> value to convert.</param>
17521752
<param name="NumberFormat">The number format to use, according to <see cref="T:System.Globalization.NumberFormatInfo" />.</param>
17531753
<summary>Converts a <see cref="T:System.Single" /> value to a <see cref="T:System.String" /> value, using the specified number format.</summary>
1754-
<returns>The <see langword="String" /> representation of the <see langword="Single" /> value.</returns>
1754+
<returns>The string representation of the <see cref="T:System.Single" /> value.</returns>
17551755
<remarks>To be added.</remarks>
17561756
</Docs>
17571757
</Member>

‎xml/Microsoft.VisualBasic.CompilerServices/FlowControl.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -346,9 +346,9 @@
346346
<Parameter Name="StepValue" Type="System.Single" />
347347
</Parameters>
348348
<Docs>
349-
<param name="count">Required. A <see langword="Single" /> value that represents the initial value passed for the loop counter variable.</param>
350-
<param name="limit">Required. A <see langword="Single" /> value that represents the value passed by using the <see langword="To" /> keyword.</param>
351-
<param name="StepValue">Required. A <see langword="Single" /> value that represents the value passed by using the <see langword="Step" /> keyword.</param>
349+
<param name="count">Required. A <see cref="T:System.Single" /> value that represents the initial value passed for the loop counter variable.</param>
350+
<param name="limit">Required. A <see cref="T:System.Single" /> value that represents the value passed by using the <see langword="To" /> keyword.</param>
351+
<param name="StepValue">Required. A <see cref="T:System.Single" /> value that represents the value passed by using the <see langword="Step" /> keyword.</param>
352352
<summary>Checks for valid values for the loop counter, <see langword="Step" />, and <see langword="To" /> values.</summary>
353353
<returns>
354354
<see langword="True" /> if <paramref name="StepValue" /> is greater than zero and <paramref name="count" /> is less than or equal to <paramref name="limit" />, or if <paramref name="StepValue" /> is less than or equal to zero and <paramref name="count" /> is greater than or equal to <paramref name="limit" />; otherwise, <see langword="False" />.</returns>

‎xml/Microsoft.VisualBasic.CompilerServices/ObjectFlowControl+ForLoopControl.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -211,9 +211,9 @@
211211
<Parameter Name="StepValue" Type="System.Single" />
212212
</Parameters>
213213
<Docs>
214-
<param name="count">Required. A <see langword="Single" /> value that represents the initial value passed for the loop counter variable.</param>
215-
<param name="limit">Required. A <see langword="Single" /> value that represents the value passed by using the <see langword="To" /> keyword.</param>
216-
<param name="StepValue">Required. A <see langword="Single" /> value that represents the value passed by using the <see langword="Step" /> keyword.</param>
214+
<param name="count">Required. A <see cref="T:System.Single" /> value that represents the initial value passed for the loop counter variable.</param>
215+
<param name="limit">Required. A <see cref="T:System.Single" /> value that represents the value passed by using the <see langword="To" /> keyword.</param>
216+
<param name="StepValue">Required. A <see cref="T:System.Single" /> value that represents the value passed by using the <see langword="Step" /> keyword.</param>
217217
<summary>Checks for valid values for the loop counter, <see langword="Step" />, and <see langword="To" /> values.</summary>
218218
<returns>
219219
<see langword="True" /> if <paramref name="StepValue" /> is greater than zero and <paramref name="count" /> is less than or equal to <paramref name="limit" />, or if <paramref name="StepValue" /> is less than or equal to zero and <paramref name="count" /> is greater than or equal to <paramref name="limit" />; otherwise, <see langword="False" />.</returns>

‎xml/Microsoft.VisualBasic.CompilerServices/SingleType.xml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<AssemblyVersion>10.0.0.0</AssemblyVersion>
5050
</AssemblyInfo>
5151
<Docs>
52-
<summary>Returns a <see langword="Single" /> value that corresponds to the specified object and optional number format information.</summary>
52+
<summary>Returns a <see cref="T:System.Single" /> value that corresponds to the specified object and optional number format information.</summary>
5353
<remarks>
5454
<format type="text/markdown"><![CDATA[
5555
@@ -93,9 +93,9 @@
9393
<Parameter Name="Value" Type="System.Object" />
9494
</Parameters>
9595
<Docs>
96-
<param name="Value">Required. Object to convert to a <see langword="Single" /> value.</param>
97-
<summary>Returns a <see langword="Single" /> value that corresponds to the specified object.</summary>
98-
<returns>The <see langword="Single" /> value corresponding to <paramref name="Value" />.</returns>
96+
<param name="Value">Required. Object to convert to a <see cref="T:System.Single" /> value.</param>
97+
<summary>Returns a <see cref="T:System.Single" /> value that corresponds to the specified object.</summary>
98+
<returns>The <see cref="T:System.Single" /> value corresponding to <paramref name="Value" />.</returns>
9999
<remarks>
100100
<format type="text/markdown"><![CDATA[
101101
@@ -136,10 +136,10 @@
136136
<Parameter Name="NumberFormat" Type="System.Globalization.NumberFormatInfo" />
137137
</Parameters>
138138
<Docs>
139-
<param name="Value">Required. Object to convert to a <see langword="Single" /> value.</param>
139+
<param name="Value">Required. Object to convert to a <see cref="T:System.Single" /> value.</param>
140140
<param name="NumberFormat">A <see cref="T:System.Globalization.NumberFormatInfo" /> object that defines how numeric values are formatted and displayed, depending on the culture.</param>
141-
<summary>Returns a <see langword="Single" /> value that corresponds to the specified object.</summary>
142-
<returns>The <see langword="Single" /> value corresponding to <paramref name="Value" />.</returns>
141+
<summary>Returns a <see cref="T:System.Single" /> value that corresponds to the specified object.</summary>
142+
<returns>The <see cref="T:System.Single" /> value corresponding to <paramref name="Value" />.</returns>
143143
<remarks>
144144
<format type="text/markdown"><![CDATA[
145145
@@ -157,7 +157,7 @@
157157
<AssemblyVersion>10.0.0.0</AssemblyVersion>
158158
</AssemblyInfo>
159159
<Docs>
160-
<summary>Returns a <see langword="Single" /> value that corresponds to the specified string and optional number format information.</summary>
160+
<summary>Returns a <see cref="T:System.Single" /> value that corresponds to the specified string and optional number format information.</summary>
161161
<remarks>
162162
<format type="text/markdown"><![CDATA[
163163
@@ -201,9 +201,9 @@
201201
<Parameter Name="Value" Type="System.String" />
202202
</Parameters>
203203
<Docs>
204-
<param name="Value">Required. String to convert to a <see langword="Single" /> value.</param>
205-
<summary>Returns a <see langword="Single" /> value that corresponds to the specified string.</summary>
206-
<returns>The <see langword="Single" /> value that corresponds to <paramref name="Value" />.</returns>
204+
<param name="Value">Required. String to convert to a <see cref="T:System.Single" /> value.</param>
205+
<summary>Returns a <see cref="T:System.Single" /> value that corresponds to the specified string.</summary>
206+
<returns>The <see cref="T:System.Single" /> value that corresponds to <paramref name="Value" />.</returns>
207207
<remarks>
208208
<format type="text/markdown"><![CDATA[
209209
@@ -244,10 +244,10 @@
244244
<Parameter Name="NumberFormat" Type="System.Globalization.NumberFormatInfo" />
245245
</Parameters>
246246
<Docs>
247-
<param name="Value">Required. String to convert to a <see langword="Single" /> value.</param>
247+
<param name="Value">Required. String to convert to a <see cref="T:System.Single" /> value.</param>
248248
<param name="NumberFormat">A <see cref="T:System.Globalization.NumberFormatInfo" /> object that defines how numeric values are formatted and displayed, depending on the culture.</param>
249-
<summary>Returns a <see langword="Single" /> value that corresponds to the specified string and number format information.</summary>
250-
<returns>The <see langword="Single" /> value corresponding to <paramref name="Value" />.</returns>
249+
<summary>Returns a <see cref="T:System.Single" /> value that corresponds to the specified string and number format information.</summary>
250+
<returns>The <see cref="T:System.Single" /> value corresponding to <paramref name="Value" />.</returns>
251251
<remarks>
252252
<format type="text/markdown"><![CDATA[
253253

‎xml/Microsoft.VisualBasic.CompilerServices/StringType.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,7 @@
601601
<AssemblyVersion>10.0.0.0</AssemblyVersion>
602602
</AssemblyInfo>
603603
<Docs>
604-
<summary>Returns a <see langword="String" /> value that corresponds to a specified <see langword="Single" /> and optional number format information.</summary>
604+
<summary>Returns a string value that corresponds to a specified <see cref="T:System.Single" /> and optional number format information.</summary>
605605
<remarks>
606606
<format type="text/markdown"><![CDATA[
607607
@@ -645,9 +645,9 @@
645645
<Parameter Name="Value" Type="System.Single" />
646646
</Parameters>
647647
<Docs>
648-
<param name="Value">Required. <see langword="Single" /> to convert to a <see langword="String" /> value.</param>
649-
<summary>Returns a <see langword="String" /> value that corresponds to a specified <see langword="Single" />.</summary>
650-
<returns>The <see langword="String" /> value corresponding to <paramref name="Value" />.</returns>
648+
<param name="Value">Required. <see cref="T:System.Single" /> to convert to a <see langword="String" /> value.</param>
649+
<summary>Returns a string value that corresponds to a specified <see cref="T:System.Single" />.</summary>
650+
<returns>The string value corresponding to <paramref name="Value" />.</returns>
651651
<remarks>
652652
<format type="text/markdown"><![CDATA[
653653
@@ -688,10 +688,10 @@
688688
<Parameter Name="NumberFormat" Type="System.Globalization.NumberFormatInfo" />
689689
</Parameters>
690690
<Docs>
691-
<param name="Value">Required. <see langword="Single" /> to convert to a <see langword="String" /> value.</param>
691+
<param name="Value">Required. <see cref="T:System.Single" /> to convert to a <see langword="String" /> value.</param>
692692
<param name="NumberFormat">A <see cref="T:System.Globalization.NumberFormatInfo" /> object that defines how numeric values are formatted and displayed, depending on the culture.</param>
693-
<summary>Returns a <see langword="String" /> value that corresponds to a specified <see langword="Single" /> and number format information.</summary>
694-
<returns>The <see langword="String" /> value corresponding to <paramref name="Value" />.</returns>
693+
<summary>Returns a string value that corresponds to a specified <see cref="T:System.Single" /> and number format information.</summary>
694+
<returns>The string value corresponding to <paramref name="Value" />.</returns>
695695
<remarks>
696696
<format type="text/markdown"><![CDATA[
697697

‎xml/Microsoft.VisualBasic/Constants.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3334,7 +3334,7 @@
33343334
</ReturnValue>
33353335
<MemberValue>4</MemberValue>
33363336
<Docs>
3337-
<summary>Indicates that the type of a variant object is <see langword="Single" />. Returned by the <see langword="VarType" /> function.</summary>
3337+
<summary>Indicates that the type of a variant object is <see cref="T:System.Single" />. Returned by the <see langword="VarType" /> function.</summary>
33383338
<remarks>
33393339
<format type="text/markdown"><![CDATA[
33403340

‎xml/Microsoft.VisualBasic/Conversion.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -782,7 +782,7 @@ Dim i2 As Integer = CInt(Fix(s)) ' Result: 173
782782
<Parameter Name="Number" Type="System.Single" />
783783
</Parameters>
784784
<Docs>
785-
<param name="Number">Required. A number of type <see langword="Single" /> or any valid numeric expression. </param>
785+
<param name="Number">Required. A number of type <see cref="T:System.Single" /> or any valid numeric expression. </param>
786786
<summary>Returns the integer portion of a number.</summary>
787787
<returns>The integer portion of a number.</returns>
788788
<remarks>
@@ -1876,7 +1876,7 @@ Dim i2 As Integer = CInt(Int(s)) ' Result: 173
18761876
<Parameter Name="Number" Type="System.Single" />
18771877
</Parameters>
18781878
<Docs>
1879-
<param name="Number">Required. A number of type <see langword="Single" /> or any valid numeric expression. </param>
1879+
<param name="Number">Required. A number of type <see cref="T:System.Single" /> or any valid numeric expression. </param>
18801880
<summary>Returns the integer portion of a number.</summary>
18811881
<returns>The integer portion of a number.</returns>
18821882
<remarks>

‎xml/Microsoft.VisualBasic/VBMath.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@
173173
<AssemblyVersion>10.0.0.0</AssemblyVersion>
174174
</AssemblyInfo>
175175
<Docs>
176-
<summary>Returns a random number of type <see langword="Single" />.</summary>
176+
<summary>Returns a random number of type <see cref="T:System.Single" />.</summary>
177177
</Docs>
178178
</MemberGroup>
179179
<Member MemberName="Rnd">
@@ -206,7 +206,7 @@
206206
</ReturnValue>
207207
<Parameters />
208208
<Docs>
209-
<summary>Returns a random number of type <see langword="Single" />.</summary>
209+
<summary>Returns a random number of type <see cref="T:System.Single" />.</summary>
210210
<returns>The next random number in the sequence.</returns>
211211
<remarks>
212212
<format type="text/markdown"><![CDATA[
@@ -268,8 +268,8 @@
268268
<Parameter Name="Number" Type="System.Single" />
269269
</Parameters>
270270
<Docs>
271-
<param name="Number">Optional. A <see langword="Single" /> value or any valid <see langword="Single" /> expression.</param>
272-
<summary>Returns a random number of type <see langword="Single" />.</summary>
271+
<param name="Number">Optional. A <see cref="T:System.Single" /> value or any valid <see cref="T:System.Single" /> expression.</param>
272+
<summary>Returns a random number of type <see cref="T:System.Single" />.</summary>
273273
<returns>If number is less than zero, Rnd generates the same number every time, using <paramref name="Number" /> as the seed. If number is greater than zero, Rnd generates the next random number in the sequence. If number is equal to zero, Rnd generates the most recently generated number. If number is not supplied, Rnd generates the next random number in the sequence.</returns>
274274
<remarks>
275275
<format type="text/markdown"><![CDATA[

‎xml/System.IO/UnmanagedMemoryAccessor.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1909,7 +1909,7 @@
19091909
<Docs>
19101910
<param name="position">The number of bytes into the accessor at which to begin writing.</param>
19111911
<param name="value">The value to write.</param>
1912-
<summary>Writes a <see langword="Single" /> into the accessor.</summary>
1912+
<summary>Writes a <see cref="T:System.Single" /> into the accessor.</summary>
19131913
<remarks>To be added.</remarks>
19141914
<exception cref="T:System.ArgumentException">There are not enough bytes after <paramref name="position" /> to write a value.</exception>
19151915
<exception cref="T:System.ArgumentOutOfRangeException">

0 commit comments

Comments
 (0)