Skip to content

Commit 7f6af85

Browse files
authored
Fix mismatched paramrefs for System.Linq, System.IO, System.Drawing, System.Globalization (#10903)
1 parent 2c0d1a4 commit 7f6af85

34 files changed

+916
-955
lines changed

xml/System.Drawing.Design/ToolboxService.xml

Lines changed: 202 additions & 202 deletions
Large diffs are not rendered by default.

xml/System.Drawing.Drawing2D/GraphicsPath.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5437,7 +5437,7 @@
54375437
<ReturnType>System.Drawing.Drawing2D.PathData</ReturnType>
54385438
</ReturnValue>
54395439
<Docs>
5440-
<summary>Gets a <see cref="T:System.Drawing.Drawing2D.PathData" /> that encapsulates arrays of points (<paramref name="points" />) and types (<paramref name="types" />) for this <see cref="T:System.Drawing.Drawing2D.GraphicsPath" />.</summary>
5440+
<summary>Gets a <see cref="T:System.Drawing.Drawing2D.PathData" /> that encapsulates arrays of points and types for this <see cref="T:System.Drawing.Drawing2D.GraphicsPath" />.</summary>
54415441
<value>A <see cref="T:System.Drawing.Drawing2D.PathData" /> that encapsulates arrays for both the points and types for this <see cref="T:System.Drawing.Drawing2D.GraphicsPath" />.</value>
54425442
<remarks>To be added.</remarks>
54435443
</Docs>

xml/System.Drawing.Imaging/EncoderParameter.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -544,7 +544,7 @@
544544
<param name="encoder">An <see cref="T:System.Drawing.Imaging.Encoder" /> object that encapsulates the globally unique identifier of the parameter category.</param>
545545
<param name="numberValues">An integer that specifies the number of values stored in the <see cref="T:System.Drawing.Imaging.EncoderParameter" /> object. The <see cref="P:System.Drawing.Imaging.EncoderParameter.NumberOfValues" /> property is set to this value.</param>
546546
<param name="type">A member of the <see cref="T:System.Drawing.Imaging.EncoderParameterValueType" /> enumeration that specifies the data type of the values stored in the <see cref="T:System.Drawing.Imaging.EncoderParameter" /> object. The <see cref="T:System.Type" /> and <see cref="P:System.Drawing.Imaging.EncoderParameter.ValueType" /> properties are set to this value.</param>
547-
<param name="value">A pointer to an array of values of the type specified by the <paramref name="Type" /> parameter.</param>
547+
<param name="value">A pointer to an array of values of the type specified by the <paramref name="type" /> parameter.</param>
548548
<summary>Initializes a new instance of the <see cref="T:System.Drawing.Imaging.EncoderParameter" /> class with the specified <see cref="T:System.Drawing.Imaging.Encoder" /> object, number of values, data type of the values, and a pointer to the values stored in the <see cref="T:System.Drawing.Imaging.EncoderParameter" /> object.</summary>
549549
<remarks>To be added.</remarks>
550550
</Docs>

xml/System.Drawing/ColorConverter.xml

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -46,20 +46,20 @@
4646
<Docs>
4747
<summary>Converts colors from one data type to another. Access this class through the <see cref="T:System.ComponentModel.TypeDescriptor" />.</summary>
4848
<remarks>
49-
<format type="text/markdown"><![CDATA[
50-
51-
## Remarks
52-
When converting from a string to a <xref:System.Drawing.Color> the <xref:System.Drawing.ColorConverter> expects the unqualified color name; otherwise, an exception will occur in the conversion process. For example, you should pass "Blue", not "System.Drawing.Color.Blue" or "Color.Blue", to the <xref:System.Drawing.ColorConverter.ConvertFrom%2A> method.
53-
54-
55-
56-
## Examples
57-
The following code example demonstrates how to use the <xref:System.ComponentModel.TypeConverter.ConvertToString%2A> method. This example is designed to be used with Windows Forms. Paste this code into a form and call the `ShowColorConverter` method when handling the form's <xref:System.Windows.Forms.Control.Paint> event, passing `e` as <xref:System.Windows.Forms.PaintEventArgs>.
58-
49+
<format type="text/markdown"><![CDATA[
50+
51+
## Remarks
52+
When converting from a string to a <xref:System.Drawing.Color> the <xref:System.Drawing.ColorConverter> expects the unqualified color name; otherwise, an exception will occur in the conversion process. For example, you should pass "Blue", not "System.Drawing.Color.Blue" or "Color.Blue", to the <xref:System.Drawing.ColorConverter.ConvertFrom%2A> method.
53+
54+
55+
56+
## Examples
57+
The following code example demonstrates how to use the <xref:System.ComponentModel.TypeConverter.ConvertToString%2A> method. This example is designed to be used with Windows Forms. Paste this code into a form and call the `ShowColorConverter` method when handling the form's <xref:System.Windows.Forms.Control.Paint> event, passing `e` as <xref:System.Windows.Forms.PaintEventArgs>.
58+
5959
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.Converters/CPP/form1.cpp" id="Snippet2":::
6060
:::code language="csharp" source="~/snippets/csharp/System.Drawing/ColorConverter/Overview/form1.cs" id="Snippet2":::
61-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.Converters/VB/form1.vb" id="Snippet2":::
62-
61+
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.Converters/VB/form1.vb" id="Snippet2":::
62+
6363
]]></format>
6464
</remarks>
6565
</Docs>
@@ -202,8 +202,8 @@
202202
</Parameter>
203203
</Parameters>
204204
<Docs>
205-
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
206-
<param name="destinationType">A <see cref="T:System.Type" /> that represents the type to which you want to convert.</param>
205+
<param name="context">A format context.</param>
206+
<param name="destinationType">The type to which you want to convert.</param>
207207
<summary>Returns a value indicating whether this converter can convert an object to the given destination type using the context.</summary>
208208
<returns>
209209
<see langword="true" /> if this converter can perform the operation; otherwise, <see langword="false" />.</returns>
@@ -262,11 +262,11 @@
262262
<summary>Converts the given object to the converter's native type.</summary>
263263
<returns>An <see cref="T:System.Object" /> representing the converted value.</returns>
264264
<remarks>
265-
<format type="text/markdown"><![CDATA[
266-
267-
## Remarks
268-
When converting from a string to a <xref:System.Drawing.Color> the <xref:System.Drawing.ColorConverter> expects the unqualified color name; otherwise, an exception will occur in the conversion process. For example, you should pass "Blue", not "System.Drawing.Color.Blue" or "Color.Blue", to the <xref:System.Drawing.ColorConverter.ConvertFrom%2A> method.
269-
265+
<format type="text/markdown"><![CDATA[
266+
267+
## Remarks
268+
When converting from a string to a <xref:System.Drawing.Color> the <xref:System.Drawing.ColorConverter> expects the unqualified color name; otherwise, an exception will occur in the conversion process. For example, you should pass "Blue", not "System.Drawing.Color.Blue" or "Color.Blue", to the <xref:System.Drawing.ColorConverter.ConvertFrom%2A> method.
269+
270270
]]></format>
271271
</remarks>
272272
<exception cref="T:System.ArgumentException">The conversion cannot be performed.</exception>
@@ -326,15 +326,15 @@
326326
<summary>Converts the specified object to another type.</summary>
327327
<returns>An <see cref="T:System.Object" /> representing the converted value.</returns>
328328
<remarks>
329-
<format type="text/markdown"><![CDATA[
330-
331-
## Remarks
332-
The most common conversion is to or from a string.
333-
329+
<format type="text/markdown"><![CDATA[
330+
331+
## Remarks
332+
The most common conversion is to or from a string.
333+
334334
]]></format>
335335
</remarks>
336336
<exception cref="T:System.ArgumentNullException">
337-
<paramref name="destinationtype" /> is <see langword="null" />.</exception>
337+
<paramref name="destinationType" /> is <see langword="null" />.</exception>
338338
<exception cref="T:System.NotSupportedException">The conversion cannot be performed.</exception>
339339
</Docs>
340340
</Member>

xml/System.Drawing/Graphics.xml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14340,11 +14340,9 @@ The <see cref="T:System.Drawing.Graphics" /> object has a transform applied othe
1434014340
## Examples
1434114341
The following code example is designed for use with Windows Forms, and it requires <xref:System.Windows.Forms.PaintEventArgs> `e`, which is a parameter of the <xref:System.Windows.Forms.Control.Paint> event handler. The code performs the following action:
1434214342

14343-
- Creates a solid blue brush.
14344-
14345-
- Creates an array of three rectangles.
14346-
14347-
- Fills the three rectangular areas on the screen.
14343+
- Creates a solid blue brush.
14344+
- Creates an array of three rectangles.
14345+
- Fills the three rectangular areas on the screen.
1434814346

1434914347
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Drawing.ClassicGraphicsExamples3/CPP/form1.cpp" id="Snippet116":::
1435014348
:::code language="csharp" source="~/snippets/csharp/System.Drawing/Graphics/FillRectangle/form1.cs" id="Snippet116":::
@@ -14359,7 +14357,7 @@ The <see cref="T:System.Drawing.Graphics" /> object has a transform applied othe
1435914357

1436014358
<paramref name="rects" /> is <see langword="null" />.</exception>
1436114359
<exception cref="T:System.ArgumentException">
14362-
<paramref name="Rects" /> is a zero-length array.</exception>
14360+
<paramref name="rects" /> is a zero-length array.</exception>
1436314361
</Docs>
1436414362
</Member>
1436514363
<Member MemberName="FillRectangles">
@@ -17154,7 +17152,7 @@ The <see cref="T:System.Drawing.Graphics" /> object has a transform applied othe
1715417152
<param name="format">
1715517153
<see cref="T:System.Drawing.StringFormat" /> that represents formatting information, such as line spacing, for the string.</param>
1715617154
<summary>Measures the specified string when drawn with the specified <see cref="T:System.Drawing.Font" /> and formatted with the specified <see cref="T:System.Drawing.StringFormat" />.</summary>
17157-
<returns>This method returns a <see cref="T:System.Drawing.SizeF" /> structure that represents the size, in the units specified by the <see cref="P:System.Drawing.Graphics.PageUnit" /> property, of the string specified in the <paramref name="text" /> parameter as drawn with the <paramref name="font" /> parameter and the <paramref name="stringFormat" /> parameter.</returns>
17155+
<returns>This method returns a <see cref="T:System.Drawing.SizeF" /> structure that represents the size, in the units specified by the <see cref="P:System.Drawing.Graphics.PageUnit" /> property, of the string specified in the <paramref name="text" /> parameter as drawn with the <paramref name="font" /> parameter and the <paramref name="format" /> parameter.</returns>
1715817156
<remarks>
1715917157
<format type="text/markdown"><![CDATA[
1716017158

xml/System.Drawing/Icon.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@
348348
349349
]]></format>
350350
</remarks>
351-
<exception cref="T:System.ArgumentException">The <paramref name="string" /> is <see langword="null" /> or does not contain image data.</exception>
351+
<exception cref="T:System.ArgumentException">The <paramref name="fileName" /> is <see langword="null" /> or does not contain image data.</exception>
352352
</Docs>
353353
</Member>
354354
<Member MemberName=".ctor">
@@ -539,7 +539,7 @@
539539
540540
]]></format>
541541
</remarks>
542-
<exception cref="T:System.ArgumentException">The <paramref name="string" /> is <see langword="null" /> or does not contain image data.</exception>
542+
<exception cref="T:System.ArgumentException">The <paramref name="fileName" /> is <see langword="null" /> or does not contain image data.</exception>
543543
</Docs>
544544
</Member>
545545
<Member MemberName="Clone">

xml/System.Globalization/CompareInfo.xml

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -184,18 +184,14 @@
184184
By default, the comparison is performed by using <xref:System.Globalization.CompareOptions.None?displayProperty=nameWithType>. If a security decision depends on a string comparison or a case change, you should use the <xref:System.Globalization.CultureInfo.InvariantCulture%2A> property to ensure that the behavior is consistent regardless of the culture settings of the operating system.
185185

186186
> [!NOTE]
187-
> When possible, you should call string comparison methods that have a parameter of type <xref:System.Globalization.CompareOptions> to specify the kind of comparison expected. As a general rule, use linguistic options (using the current culture) for comparing strings displayed in the user interface and specify <xref:System.Globalization.CompareOptions.Ordinal> or <xref:System.Globalization.CompareOptions.OrdinalIgnoreCase> for security comparisons.
188-
189-
187+
> When possible, you should call string comparison methods that have a parameter of type <xref:System.Globalization.CompareOptions> to specify the kind of comparison expected. As a general rule, use linguistic options (using the current culture) for comparing strings displayed in the user interface and specify <xref:System.Globalization.CompareOptions.Ordinal> or <xref:System.Globalization.CompareOptions.OrdinalIgnoreCase> for security comparisons.
190188

191189
## Examples
192190
The following example compares portions of two strings using the different <xref:System.Globalization.CompareInfo> objects:
193191

194-
- <xref:System.Globalization.CompareInfo> object associated with the Spanish (Spain) culture with international sort
195-
196-
- <xref:System.Globalization.CompareInfo> object associated with the Spanish (Spain) culture with traditional sort
197-
198-
- <xref:System.Globalization.CompareInfo> object associated with the <xref:System.Globalization.CultureInfo.InvariantCulture%2A>
192+
- <xref:System.Globalization.CompareInfo> object associated with the Spanish (Spain) culture with international sort
193+
- <xref:System.Globalization.CompareInfo> object associated with the Spanish (Spain) culture with traditional sort
194+
- <xref:System.Globalization.CompareInfo> object associated with the <xref:System.Globalization.CultureInfo.InvariantCulture%2A>
199195

200196
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Globalization.CompareInfo.CompareStrStr/CPP/comparestrstr.cpp" id="Snippet1":::
201197
:::code language="csharp" source="~/snippets/csharp/System.Globalization/CompareInfo/Compare/comparestrstr.cs" id="Snippet1":::
@@ -3441,7 +3437,7 @@ This method has greater overhead than other <xref:System.Globalization.CompareIn
34413437
<param name="text">A string of zero or more Unicode characters.</param>
34423438
<summary>Indicates whether a specified Unicode string is sortable.</summary>
34433439
<returns>
3444-
<see langword="true" /> if the <paramref name="str" /> parameter is not an empty string ("") and all the Unicode characters in <paramref name="str" /> are sortable; otherwise, <see langword="false" />.</returns>
3440+
<see langword="true" /> if the <paramref name="text" /> parameter is not an empty string ("") and all the Unicode characters in <paramref name="text" /> are sortable; otherwise, <see langword="false" />.</returns>
34453441
<remarks>
34463442
<format type="text/markdown"><![CDATA[
34473443

@@ -3451,7 +3447,7 @@ This method has greater overhead than other <xref:System.Globalization.CompareIn
34513447
]]></format>
34523448
</remarks>
34533449
<exception cref="T:System.ArgumentNullException">
3454-
<paramref name="str" /> is <see langword="null" />.</exception>
3450+
<paramref name="text" /> is <see langword="null" />.</exception>
34553451
</Docs>
34563452
</Member>
34573453
<Member MemberName="IsSortable">

xml/System.Globalization/CultureAndRegionInfoBuilder.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ The following code example creates a custom culture with a private use prefix, t
8989

9090
-or-
9191

92-
<paramref name="cultureName" /> specifies an alternate sort replacement culture instead of a .NET Framework culture. For example, <paramref name="culturenName" /> is "de-de_phoneb", a culture that sorts strings as they appear in a German telephone book, instead of "de-DE", the German (Germany) culture.
92+
<paramref name="cultureName" /> specifies an alternate sort replacement culture instead of a .NET Framework culture. For example, <paramref name="cultureName" /> is "de-de_phoneb", a culture that sorts strings as they appear in a German telephone book, instead of "de-DE", the German (Germany) culture.
9393

9494
-or-
9595

0 commit comments

Comments
 (0)