Skip to content

Commit 62355a7

Browse files
nxtncarlossanlop
nxtn
and
carlossanlop
authored
Replace <see langword="Double" /> tags (#4005)
* Replace <see langword="Double" /> tags * Apply suggestions from code review Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Move notes into remarks Co-authored-by: Carlos Sanchez Lopez <[email protected]>
1 parent dc05b0d commit 62355a7

File tree

22 files changed

+90
-90
lines changed

22 files changed

+90
-90
lines changed

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2283,9 +2283,9 @@
22832283
<Parameter Name="X" Type="System.Double" />
22842284
</Parameters>
22852285
<Docs>
2286-
<param name="X">A <see langword="Double" /> that contains the X coordinate to convert.</param>
2286+
<param name="X">A <see cref="T:System.Double" /> that contains the X coordinate to convert.</param>
22872287
<summary>Converts an X coordinate from pixels to twips.</summary>
2288-
<returns>A <see langword="Double" /> that contains the X coordinate expressed in twips.</returns>
2288+
<returns>A <see cref="T:System.Double" /> that contains the X coordinate expressed in twips.</returns>
22892289
<remarks>
22902290
<format type="text/markdown"><![CDATA[
22912291
@@ -2324,9 +2324,9 @@
23242324
<Parameter Name="Y" Type="System.Double" />
23252325
</Parameters>
23262326
<Docs>
2327-
<param name="Y">A <see langword="Double" /> that contains the Y coordinate to convert.</param>
2327+
<param name="Y">A <see cref="T:System.Double" /> that contains the Y coordinate to convert.</param>
23282328
<summary>Converts a Y coordinate from pixels to twips.</summary>
2329-
<returns>A <see langword="Double" /> that contains the Y coordinate expressed in twips.</returns>
2329+
<returns>A <see cref="T:System.Double" /> that contains the Y coordinate expressed in twips.</returns>
23302330
<remarks>
23312331
<format type="text/markdown"><![CDATA[
23322332
@@ -3035,7 +3035,7 @@
30353035
<Parameters />
30363036
<Docs>
30373037
<summary>Gets a value that is used to convert twips to pixels based on screen settings.</summary>
3038-
<returns>A <see langword="Double" /> that contains the conversion factor.</returns>
3038+
<returns>A <see cref="T:System.Double" /> that contains the conversion factor.</returns>
30393039
<remarks>
30403040
<format type="text/markdown"><![CDATA[
30413041
@@ -3073,7 +3073,7 @@
30733073
<Parameters />
30743074
<Docs>
30753075
<summary>Gets a value that is used to convert twips to pixels based on screen settings.</summary>
3076-
<returns>A <see langword="Double" /> that contains the conversion factor.</returns>
3076+
<returns>A <see cref="T:System.Double" /> that contains the conversion factor.</returns>
30773077
<remarks>
30783078
<format type="text/markdown"><![CDATA[
30793079
@@ -3112,9 +3112,9 @@
31123112
<Parameter Name="X" Type="System.Double" />
31133113
</Parameters>
31143114
<Docs>
3115-
<param name="X">A <see langword="Double" /> that contains the X coordinate to convert.</param>
3115+
<param name="X">A <see cref="T:System.Double" /> that contains the X coordinate to convert.</param>
31163116
<summary>Converts an X coordinate from twips to pixels.</summary>
3117-
<returns>A <see langword="Double" /> that contains the X coordinate expressed in pixels.</returns>
3117+
<returns>A <see cref="T:System.Double" /> that contains the X coordinate expressed in pixels.</returns>
31183118
<remarks>
31193119
<format type="text/markdown"><![CDATA[
31203120
@@ -3153,9 +3153,9 @@
31533153
<Parameter Name="Y" Type="System.Double" />
31543154
</Parameters>
31553155
<Docs>
3156-
<param name="Y">A <see langword="Double" /> that contains the X coordinate to convert.</param>
3156+
<param name="Y">A <see cref="T:System.Double" /> that contains the X coordinate to convert.</param>
31573157
<summary>Converts a Y coordinate from twips to pixels.</summary>
3158-
<returns>A <see langword="Double" /> that contains the Y coordinate expressed in pixels.</returns>
3158+
<returns>A <see cref="T:System.Double" /> that contains the Y coordinate expressed in pixels.</returns>
31593159
<remarks>
31603160
<format type="text/markdown"><![CDATA[
31613161

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -757,7 +757,7 @@
757757
<Docs>
758758
<param name="Value">The object to convert.</param>
759759
<summary>Converts an object to a <see cref="T:System.Double" /> value.</summary>
760-
<returns>The <see langword="Double" /> value of the object.</returns>
760+
<returns>The <see cref="T:System.Double" /> value of the object.</returns>
761761
<remarks>To be added.</remarks>
762762
</Docs>
763763
</Member>
@@ -795,7 +795,7 @@
795795
<Docs>
796796
<param name="Value">The string to convert.</param>
797797
<summary>Converts a string to a <see cref="T:System.Double" /> value.</summary>
798-
<returns>The <see langword="Double" /> value of the string.</returns>
798+
<returns>The <see cref="T:System.Double" /> value of the string.</returns>
799799
<remarks>To be added.</remarks>
800800
</Docs>
801801
</Member>
@@ -1444,9 +1444,9 @@
14441444
<Parameter Name="Value" Type="System.Double" />
14451445
</Parameters>
14461446
<Docs>
1447-
<param name="Value">The <see langword="Double" /> value to convert.</param>
1447+
<param name="Value">The <see cref="T:System.Double" /> value to convert.</param>
14481448
<summary>Converts a <see cref="T:System.Double" /> value to a <see cref="T:System.String" /> value.</summary>
1449-
<returns>The <see langword="String" /> representation of the <see langword="Double" /> value.</returns>
1449+
<returns>The string representation of the <see cref="T:System.Double" /> value.</returns>
14501450
<remarks>To be added.</remarks>
14511451
</Docs>
14521452
</Member>
@@ -1761,10 +1761,10 @@
17611761
<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;net-5.0" />
17621762
</Parameters>
17631763
<Docs>
1764-
<param name="Value">The <see langword="Double" /> value to convert.</param>
1764+
<param name="Value">The <see cref="T:System.Double" /> value to convert.</param>
17651765
<param name="NumberFormat">The number format to use, according to <see cref="T:System.Globalization.NumberFormatInfo" />.</param>
17661766
<summary>Converts a <see cref="T:System.Double" /> value to a <see cref="T:System.String" /> value, using the specified number format.</summary>
1767-
<returns>The <see langword="String" /> representation of the <see langword="Double" /> value.</returns>
1767+
<returns>The string representation of the <see cref="T:System.Double" /> value.</returns>
17681768
<remarks>To be added.</remarks>
17691769
</Docs>
17701770
</Member>

‎xml/Microsoft.VisualBasic.CompilerServices/DoubleType.xml

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<AssemblyVersion>10.0.0.0</AssemblyVersion>
5151
</AssemblyInfo>
5252
<Docs>
53-
<summary>Returns a <see langword="Double" /> value that corresponds to the specified object and optional number format information.</summary>
53+
<summary>Returns a <see cref="T:System.Double" /> value that corresponds to the specified object and optional number format information.</summary>
5454
<remarks>
5555
<format type="text/markdown"><![CDATA[
5656
@@ -95,9 +95,9 @@
9595
<Parameter Name="Value" Type="System.Object" />
9696
</Parameters>
9797
<Docs>
98-
<param name="Value">Required. Object to convert to a <see langword="Double" /> value.</param>
99-
<summary>Returns a <see langword="Double" /> value that corresponds to the specified object.</summary>
100-
<returns>The <see langword="Double" /> value corresponding to <paramref name="Value" />.</returns>
98+
<param name="Value">Required. Object to convert to a <see cref="T:System.Double" /> value.</param>
99+
<summary>Returns a <see cref="T:System.Double" /> value that corresponds to the specified object.</summary>
100+
<returns>The <see cref="T:System.Double" /> value corresponding to <paramref name="Value" />.</returns>
101101
<remarks>
102102
<format type="text/markdown"><![CDATA[
103103
@@ -139,10 +139,10 @@
139139
<Parameter Name="NumberFormat" Type="System.Globalization.NumberFormatInfo" />
140140
</Parameters>
141141
<Docs>
142-
<param name="Value">Required. Object to convert to a <see langword="Double" /> value.</param>
142+
<param name="Value">Required. Object to convert to a <see cref="T:System.Double" /> value.</param>
143143
<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>
144-
<summary>Returns a <see langword="Double" /> value that corresponds to the specified object.</summary>
145-
<returns>The <see langword="Double" /> value corresponding to <paramref name="Value" />.</returns>
144+
<summary>Returns a <see cref="T:System.Double" /> value that corresponds to the specified object.</summary>
145+
<returns>The <see cref="T:System.Double" /> value corresponding to <paramref name="Value" />.</returns>
146146
<remarks>
147147
<format type="text/markdown"><![CDATA[
148148
@@ -160,7 +160,7 @@
160160
<AssemblyVersion>10.0.0.0</AssemblyVersion>
161161
</AssemblyInfo>
162162
<Docs>
163-
<summary>Returns a <see langword="Double" /> value that corresponds to the specified string and optional number format information.</summary>
163+
<summary>Returns a <see cref="T:System.Double" /> value that corresponds to the specified string and optional number format information.</summary>
164164
<remarks>
165165
<format type="text/markdown"><![CDATA[
166166
@@ -205,9 +205,9 @@
205205
<Parameter Name="Value" Type="System.String" />
206206
</Parameters>
207207
<Docs>
208-
<param name="Value">Required. String to convert to a <see langword="Double" /> value.</param>
209-
<summary>Returns a <see langword="Double" /> value that corresponds to the specified string.</summary>
210-
<returns>The <see langword="Double" /> value corresponding to <paramref name="Value" />.</returns>
208+
<param name="Value">Required. String to convert to a <see cref="T:System.Double" /> value.</param>
209+
<summary>Returns a <see cref="T:System.Double" /> value that corresponds to the specified string.</summary>
210+
<returns>The <see cref="T:System.Double" /> value corresponding to <paramref name="Value" />.</returns>
211211
<remarks>
212212
<format type="text/markdown"><![CDATA[
213213
@@ -249,10 +249,10 @@
249249
<Parameter Name="NumberFormat" Type="System.Globalization.NumberFormatInfo" />
250250
</Parameters>
251251
<Docs>
252-
<param name="Value">Required. String to convert to a <see langword="Double" /> value.</param>
252+
<param name="Value">Required. String to convert to a <see cref="T:System.Double" /> value.</param>
253253
<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>
254-
<summary>Returns a <see langword="Double" /> value that corresponds to the specified string and number format information.</summary>
255-
<returns>The <see langword="Double" /> value corresponding to <paramref name="Value" />.</returns>
254+
<summary>Returns a <see cref="T:System.Double" /> value that corresponds to the specified string and number format information.</summary>
255+
<returns>The <see cref="T:System.Double" /> value corresponding to <paramref name="Value" />.</returns>
256256
<remarks>
257257
<format type="text/markdown"><![CDATA[
258258
@@ -270,7 +270,7 @@
270270
<AssemblyVersion>10.0.0.0</AssemblyVersion>
271271
</AssemblyInfo>
272272
<Docs>
273-
<summary>Returns a <see langword="Double" /> value that corresponds to the specified string and optional number format information.</summary>
273+
<summary>Returns a <see cref="T:System.Double" /> value that corresponds to the specified string and optional number format information.</summary>
274274
<remarks>
275275
<format type="text/markdown"><![CDATA[
276276
@@ -315,9 +315,9 @@
315315
<Parameter Name="Value" Type="System.String" />
316316
</Parameters>
317317
<Docs>
318-
<param name="Value">Required. String to convert to a <see langword="Double" /> value.</param>
319-
<summary>Returns a <see langword="Double" /> value that corresponds to the specified string.</summary>
320-
<returns>The <see langword="Double" /> value corresponding to <paramref name="Value" />.</returns>
318+
<param name="Value">Required. String to convert to a <see cref="T:System.Double" /> value.</param>
319+
<summary>Returns a <see cref="T:System.Double" /> value that corresponds to the specified string.</summary>
320+
<returns>The <see cref="T:System.Double" /> value corresponding to <paramref name="Value" />.</returns>
321321
<remarks>
322322
<format type="text/markdown"><![CDATA[
323323
@@ -359,10 +359,10 @@
359359
<Parameter Name="NumberFormat" Type="System.Globalization.NumberFormatInfo" />
360360
</Parameters>
361361
<Docs>
362-
<param name="Value">Required. String to convert to a <see langword="Double" /> value.</param>
362+
<param name="Value">Required. String to convert to a <see cref="T:System.Double" /> value.</param>
363363
<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>
364-
<summary>Returns a <see langword="Double" /> value that corresponds to the specified string and number format information.</summary>
365-
<returns>The <see langword="Double" /> value corresponding to <paramref name="Value" />.</returns>
364+
<summary>Returns a <see cref="T:System.Double" /> value that corresponds to the specified string and number format information.</summary>
365+
<returns>The <see cref="T:System.Double" /> value corresponding to <paramref name="Value" />.</returns>
366366
<remarks>
367367
<format type="text/markdown"><![CDATA[
368368

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -388,9 +388,9 @@
388388
<Parameter Name="StepValue" Type="System.Double" />
389389
</Parameters>
390390
<Docs>
391-
<param name="count">Required. A <see langword="Double" /> value that represents the initial value passed for the loop counter variable.</param>
392-
<param name="limit">Required. A <see langword="Double" /> value that represents the value passed by using the <see langword="To" /> keyword.</param>
393-
<param name="StepValue">Required. A <see langword="Double" /> value that represents the value passed by using the <see langword="Step" /> keyword.</param>
391+
<param name="count">Required. A <see cref="T:System.Double" /> value that represents the initial value passed for the loop counter variable.</param>
392+
<param name="limit">Required. A <see cref="T:System.Double" /> value that represents the value passed by using the <see langword="To" /> keyword.</param>
393+
<param name="StepValue">Required. A <see cref="T:System.Double" /> value that represents the value passed by using the <see langword="Step" /> keyword.</param>
394394
<summary>Checks for valid values for the loop counter, <see langword="Step" />, and <see langword="To" /> values.</summary>
395395
<returns>
396396
<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
@@ -263,9 +263,9 @@
263263
<Parameter Name="StepValue" Type="System.Double" />
264264
</Parameters>
265265
<Docs>
266-
<param name="count">Required. A <see langword="Double" /> value that represents the initial value passed for the loop counter variable.</param>
267-
<param name="limit">Required. A <see langword="Double" /> value that represents the value passed by using the <see langword="To" /> keyword.</param>
268-
<param name="StepValue">Required. A <see langword="Double" /> value that represents the value passed by using the <see langword="Step" /> keyword.</param>
266+
<param name="count">Required. A <see cref="T:System.Double" /> value that represents the initial value passed for the loop counter variable.</param>
267+
<param name="limit">Required. A <see cref="T:System.Double" /> value that represents the value passed by using the <see langword="To" /> keyword.</param>
268+
<param name="StepValue">Required. A <see cref="T:System.Double" /> value that represents the value passed by using the <see langword="Step" /> keyword.</param>
269269
<summary>Checks for valid values for the loop counter, <see langword="Step" />, and <see langword="To" /> values.</summary>
270270
<returns>
271271
<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/StringType.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@
332332
<AssemblyVersion>10.0.0.0</AssemblyVersion>
333333
</AssemblyInfo>
334334
<Docs>
335-
<summary>Returns a <see langword="String" /> value that corresponds to a specified <see langword="Double" /> and optional number format information.</summary>
335+
<summary>Returns a string that corresponds to a specified <see cref="T:System.Double" /> and optional number format information.</summary>
336336
<remarks>
337337
<format type="text/markdown"><![CDATA[
338338
@@ -377,8 +377,8 @@
377377
<Parameter Name="Value" Type="System.Double" />
378378
</Parameters>
379379
<Docs>
380-
<param name="Value">Required. <see langword="Double" /> to convert to a <see langword="String" /> value.</param>
381-
<summary>Returns a <see langword="String" /> value that corresponds to a specified <see langword="Double" />.</summary>
380+
<param name="Value">Required. <see cref="T:System.Double" /> to convert to a <see cref="T:System.String" /> value.</param>
381+
<summary>Returns a string value that corresponds to a specified <see cref="T:System.Double" />.</summary>
382382
<returns>The <see langword="String" /> value corresponding to <paramref name="Value" />.</returns>
383383
<remarks>
384384
<format type="text/markdown"><![CDATA[
@@ -421,10 +421,10 @@
421421
<Parameter Name="NumberFormat" Type="System.Globalization.NumberFormatInfo" />
422422
</Parameters>
423423
<Docs>
424-
<param name="Value">Required. <see langword="Double" /> to convert to a <see langword="String" /> value.</param>
424+
<param name="Value">Required. <see cref="T:System.Double" /> to convert to a <see cref="T:System.String" /> value.</param>
425425
<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>
426-
<summary>Returns a <see langword="String" /> value that corresponds to a specified <see langword="Double" /> and number format information.</summary>
427-
<returns>The <see langword="String" /> value corresponding to <paramref name="Value" />.</returns>
426+
<summary>Returns a string that corresponds to a specified <see cref="T:System.Double" /> and number format information.</summary>
427+
<returns>The string representation of <paramref name="Value" />.</returns>
428428
<remarks>
429429
<format type="text/markdown"><![CDATA[
430430

0 commit comments

Comments
 (0)