Skip to content

Commit d09e3ec

Browse files
authored
Fix mismatched paramrefs (System.Xml/Xaml/Windows) (#11157)
1 parent 7641008 commit d09e3ec

27 files changed

+2429
-2449
lines changed

xml/System.Windows/DataObject.xml

+4-4
Original file line numberDiff line numberDiff line change
@@ -2319,7 +2319,7 @@
23192319

23202320
</description></item><item><term> E_NOTIMPL
23212321

2322-
</term><description> The direction specified by the <paramref name="direction" /> parameter is not supported.
2322+
</term><description> The direction specified by the <paramref name="dwDirection" /> parameter is not supported.
23232323

23242324
</description></item><item><term> OLE_S_USEREG
23252325

@@ -2387,15 +2387,15 @@
23872387

23882388
</description></item><item><term> DATA_S_SAMEFORMATETC
23892389

2390-
</term><description> The <see cref="T:System.Runtime.InteropServices.ComTypes.FORMATETC" /> structures are the same and <see langword="null" /> is returned in the <paramref name="formatOut" /> parameter.
2390+
</term><description> The <see cref="T:System.Runtime.InteropServices.ComTypes.FORMATETC" /> structures are the same and <see langword="null" /> is returned in the <paramref name="pformatetcOut" /> parameter.
23912391

23922392
</description></item><item><term> DV_E_LINDEX
23932393

23942394
</term><description> There is an invalid value for <see cref="F:System.Runtime.InteropServices.ComTypes.FORMATETC.lindex" />; currently, only -1 is supported.
23952395

23962396
</description></item><item><term> DV_E_FORMATETC
23972397

2398-
</term><description> There is an invalid value for the <paramref name="pFormatetc" /> parameter.
2398+
</term><description> There is an invalid value for the <paramref name="pformatetcIn" /> parameter.
23992399

24002400
</description></item><item><term> OLE_E_NOTRUNNING
24012401

@@ -2563,7 +2563,7 @@
25632563

25642564
</description></item><item><term> DV_E_FORMATETC
25652565

2566-
</term><description> An invalid value for the <paramref name="pFormatetc" /> parameter.
2566+
</term><description> An invalid value for the <paramref name="formatetc" /> parameter.
25672567

25682568
</description></item><item><term> DV_E_TYMED
25692569

xml/System.Windows/DependencyObjectType.xml

+40-40
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@
2323
<Docs>
2424
<summary>Implements an underlying type cache for all <see cref="T:System.Windows.DependencyObject" /> derived types.</summary>
2525
<remarks>
26-
<format type="text/markdown"><![CDATA[
27-
28-
## Remarks
29-
<xref:System.Windows.DependencyObjectType> represents a specific underlying system (CLR) <xref:System.Type> of a <xref:System.Windows.DependencyObject>. <xref:System.Windows.DependencyObjectType> is essentially a wrapper for the (CLR) <xref:System.Type> so that it can extend some of its capabilities.
30-
31-
This class has no public constructor. Instances of this class can only be obtained through properties on other objects (such as <xref:System.Windows.DependencyObject.DependencyObjectType%2A?displayProperty=nameWithType>), or through the static method <xref:System.Windows.DependencyObjectType.FromSystemType%2A>.
32-
26+
<format type="text/markdown"><![CDATA[
27+
28+
## Remarks
29+
<xref:System.Windows.DependencyObjectType> represents a specific underlying system (CLR) <xref:System.Type> of a <xref:System.Windows.DependencyObject>. <xref:System.Windows.DependencyObjectType> is essentially a wrapper for the (CLR) <xref:System.Type> so that it can extend some of its capabilities.
30+
31+
This class has no public constructor. Instances of this class can only be obtained through properties on other objects (such as <xref:System.Windows.DependencyObject.DependencyObjectType%2A?displayProperty=nameWithType>), or through the static method <xref:System.Windows.DependencyObjectType.FromSystemType%2A>.
32+
3333
]]></format>
3434
</remarks>
3535
<altmember cref="T:System.Windows.DependencyProperty" />
@@ -99,19 +99,19 @@
9999
<summary>Returns a <see cref="T:System.Windows.DependencyObjectType" /> that represents a given system (CLR) type.</summary>
100100
<returns>A <see cref="T:System.Windows.DependencyObjectType" /> that represents the system (CLR) type.</returns>
101101
<remarks>
102-
<format type="text/markdown"><![CDATA[
103-
104-
## Remarks
105-
Each <xref:System.Windows.DependencyObject> maintains a <xref:System.Windows.DependencyObject.DependencyObjectType%2A> property that returns a <xref:System.Windows.DependencyObjectType>, but this requires having a particular <xref:System.Windows.DependencyObject> instance. You can use this static utility method if you do not yet have a <xref:System.Windows.DependencyObject> instance and require a <xref:System.Windows.DependencyObjectType>.
106-
107-
108-
109-
## Examples
110-
The following example calls <xref:System.Windows.DependencyObjectType.FromSystemType%2A> , creating a <xref:System.Windows.DependencyObjectType> based on the type of the <xref:System.Windows.Window> class.
111-
102+
<format type="text/markdown"><![CDATA[
103+
104+
## Remarks
105+
Each <xref:System.Windows.DependencyObject> maintains a <xref:System.Windows.DependencyObject.DependencyObjectType%2A> property that returns a <xref:System.Windows.DependencyObjectType>, but this requires having a particular <xref:System.Windows.DependencyObject> instance. You can use this static utility method if you do not yet have a <xref:System.Windows.DependencyObject> instance and require a <xref:System.Windows.DependencyObjectType>.
106+
107+
108+
109+
## Examples
110+
The following example calls <xref:System.Windows.DependencyObjectType.FromSystemType%2A> , creating a <xref:System.Windows.DependencyObjectType> based on the type of the <xref:System.Windows.Window> class.
111+
112112
:::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyObjectType/FromSystemType/page3.xaml.cs" id="Snippetdotfromsystemtype":::
113-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/PropertiesOvwSupport/visualbasic/page3.xaml.vb" id="Snippetdotfromsystemtype":::
114-
113+
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/PropertiesOvwSupport/visualbasic/page3.xaml.vb" id="Snippetdotfromsystemtype":::
114+
115115
]]></format>
116116
</remarks>
117117
</Docs>
@@ -143,11 +143,11 @@
143143
<summary>Returns the hash code for this <see cref="T:System.Windows.DependencyObjectType" />.</summary>
144144
<returns>A 32-bit signed integer hash code.</returns>
145145
<remarks>
146-
<format type="text/markdown"><![CDATA[
147-
148-
## Remarks
149-
This implementation is linked to the value of the <xref:System.Windows.DependencyObjectType.Id%2A> property.
150-
146+
<format type="text/markdown"><![CDATA[
147+
148+
## Remarks
149+
This implementation is linked to the value of the <xref:System.Windows.DependencyObjectType.Id%2A> property.
150+
151151
]]></format>
152152
</remarks>
153153
</Docs>
@@ -184,11 +184,11 @@
184184
<summary>Gets a zero-based unique identifier for constant-time array lookup operations.</summary>
185185
<value>An internal identifier.</value>
186186
<remarks>
187-
<format type="text/markdown"><![CDATA[
188-
189-
## Remarks
190-
Do not use for general hashing functions. There is no guarantee on this value. It can vary between application runs.
191-
187+
<format type="text/markdown"><![CDATA[
188+
189+
## Remarks
190+
Do not use for general hashing functions. There is no guarantee on this value. It can vary between application runs.
191+
192192
]]></format>
193193
</remarks>
194194
</Docs>
@@ -222,13 +222,13 @@
222222
<param name="dependencyObject">The object to compare with the current <see cref="T:System.Windows.DependencyObjectType" />.</param>
223223
<summary>Determines whether the specified object is an instance of the current <see cref="T:System.Windows.DependencyObjectType" />.</summary>
224224
<returns>
225-
<see langword="true" /> if the class represented by the current <see cref="T:System.Windows.DependencyObjectType" /> is in the inheritance hierarchy of the <see cref="T:System.Windows.DependencyObject" /> passed as <paramref name="d" />; otherwise, <see langword="false" />.</returns>
225+
<see langword="true" /> if the class represented by the current <see cref="T:System.Windows.DependencyObjectType" /> is in the inheritance hierarchy of the <see cref="T:System.Windows.DependencyObject" /> passed as <paramref name="dependencyObject" />; otherwise, <see langword="false" />.</returns>
226226
<remarks>
227-
<format type="text/markdown"><![CDATA[
228-
229-
## Remarks
230-
Objects of the exact same type return `true`.
231-
227+
<format type="text/markdown"><![CDATA[
228+
229+
## Remarks
230+
Objects of the exact same type return `true`.
231+
232232
]]></format>
233233
</remarks>
234234
</Docs>
@@ -292,11 +292,11 @@
292292
<summary>Gets the name of the represented common language runtime (CLR) system type.</summary>
293293
<value>The name of the represented CLR system type.</value>
294294
<remarks>
295-
<format type="text/markdown"><![CDATA[
296-
297-
## Remarks
298-
The value of <xref:System.Windows.DependencyObjectType.Name%2A> is the same string as the name of the type name of the <xref:System.Type>.
299-
295+
<format type="text/markdown"><![CDATA[
296+
297+
## Remarks
298+
The value of <xref:System.Windows.DependencyObjectType.Name%2A> is the same string as the name of the type name of the <xref:System.Type>.
299+
300300
]]></format>
301301
</remarks>
302302
<altmember cref="T:System.Windows.DependencyProperty" />

xml/System.Windows/FrameworkElement.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,7 @@
441441
<returns>The actual size used.</returns>
442442
<remarks>To be added.</remarks>
443443
<block subset="none" type="overrides">
444-
<para>Control authors who want to customize the arrange pass of layout processing should override this method. The implementation pattern should call <see cref="M:System.Windows.UIElement.Arrange(System.Windows.Rect)" /> on each visible child element, and pass the final desired size for each child element as the <paramref name="finalRect" /> parameter. Parent elements should call <see cref="M:System.Windows.UIElement.Arrange(System.Windows.Rect)" /> on each child, otherwise the child elements will not be rendered.
444+
<para>Control authors who want to customize the arrange pass of layout processing should override this method. The implementation pattern should call <see cref="M:System.Windows.UIElement.Arrange(System.Windows.Rect)" /> on each visible child element, and pass the final desired size for each child element as the <paramref name="finalSize" /> parameter. Parent elements should call <see cref="M:System.Windows.UIElement.Arrange(System.Windows.Rect)" /> on each child, otherwise the child elements will not be rendered.
445445

446446
Many derived classes offer implementations of this method. Prominent ones include: <see cref="M:System.Windows.Window.ArrangeOverride(System.Windows.Size)" />, <see cref="M:System.Windows.Controls.Page.ArrangeOverride(System.Windows.Size)" /> and <see cref="M:System.Windows.Controls.Control.ArrangeOverride(System.Windows.Size)" />.</para>
447447
</block>
@@ -5896,7 +5896,7 @@
58965896
<Docs>
58975897
<param name="resourceKey">The key identifier of the resource to be found.</param>
58985898
<summary>Searches for a resource with the specified key, and returns that resource if found.</summary>
5899-
<returns>The found resource, or <see langword="null" /> if no resource with the provided <paramref name="key" /> is found.</returns>
5899+
<returns>The found resource, or <see langword="null" /> if no resource with the provided <paramref name="resourceKey" /> is found.</returns>
59005900
<remarks>
59015901
<format type="text/markdown"><![CDATA[
59025902

xml/System.Windows/GridLength.xml

+37-37
Original file line numberDiff line numberDiff line change
@@ -33,43 +33,43 @@
3333
<Docs>
3434
<summary>Represents the length of elements that explicitly support <see cref="F:System.Windows.GridUnitType.Star" /> unit types.</summary>
3535
<remarks>
36-
<format type="text/markdown"><![CDATA[
37-
38-
## Remarks
39-
Elements such as <xref:System.Windows.Controls.ColumnDefinition> and <xref:System.Windows.Controls.RowDefinition> use this type to describe width and height in order to support variable distribution of available space.
40-
41-
<a name="xamlAttributeUsage_GridLength"></a>
42-
## XAML Attribute Usage
43-
36+
<format type="text/markdown"><![CDATA[
37+
38+
## Remarks
39+
Elements such as <xref:System.Windows.Controls.ColumnDefinition> and <xref:System.Windows.Controls.RowDefinition> use this type to describe width and height in order to support variable distribution of available space.
40+
41+
<a name="xamlAttributeUsage_GridLength"></a>
42+
## XAML Attribute Usage
43+
4444
```xaml
45-
<object property="doubleLength"/>
45+
<object property="doubleLength"/>
4646
```
4747
4848
-or-
4949
5050
```xaml
51-
<object property="autoValue"/>
52-
```
53-
54-
<a name="xamlValues_GridLength"></a>
55-
## XAML Values
56-
*doubleLength*
57-
The element's length, described as either a <xref:System.Double> value that specifies a device-independent units (1/96th inch per unit) measure, or as a *qualifiedDouble* (see below).
58-
59-
*autoValue*
60-
The element's length, described by either the value Auto or *. See <xref:System.Windows.GridUnitType> for more information on the values Auto and *.
61-
62-
*qualifiedDouble*
63-
A *double* value as described above for any of the measures, followed by one of the following unit declaration strings: `px`, `in`, `cm`, `pt`.
64-
65-
`px` (default) is device-independent units (1/96th inch per unit)
66-
67-
`in` is inches; 1in==96px
68-
69-
`cm` is centimeters; 1cm==(96/2.54) px
70-
71-
`pt` is points; 1pt==(96/72) px
72-
51+
<object property="autoValue"/>
52+
```
53+
54+
<a name="xamlValues_GridLength"></a>
55+
## XAML Values
56+
*doubleLength*
57+
The element's length, described as either a <xref:System.Double> value that specifies a device-independent units (1/96th inch per unit) measure, or as a *qualifiedDouble* (see below).
58+
59+
*autoValue*
60+
The element's length, described by either the value Auto or *. See <xref:System.Windows.GridUnitType> for more information on the values Auto and *.
61+
62+
*qualifiedDouble*
63+
A *double* value as described above for any of the measures, followed by one of the following unit declaration strings: `px`, `in`, `cm`, `pt`.
64+
65+
`px` (default) is device-independent units (1/96th inch per unit)
66+
67+
`in` is inches; 1in==96px
68+
69+
`cm` is centimeters; 1cm==(96/2.54) px
70+
71+
`pt` is points; 1pt==(96/72) px
72+
7373
]]></format>
7474
</remarks>
7575
<altmember cref="T:System.Windows.GridUnitType" />
@@ -117,7 +117,7 @@
117117
<summary>Initializes a new instance of the <see cref="T:System.Windows.GridLength" /> structure using the specified absolute value in pixels.</summary>
118118
<remarks>To be added.</remarks>
119119
<exception cref="T:System.ArgumentException">
120-
<paramref name="Pixels" /> is equal to <see cref="F:System.Double.NegativeInfinity" />, <see cref="F:System.Double.PositiveInfinity" />, or <see cref="F:System.Double.NaN" />.</exception>
120+
<paramref name="pixels" /> is equal to <see cref="F:System.Double.NegativeInfinity" />, <see cref="F:System.Double.PositiveInfinity" />, or <see cref="F:System.Double.NaN" />.</exception>
121121
</Docs>
122122
</Member>
123123
<Member MemberName=".ctor">
@@ -389,11 +389,11 @@
389389
<value>
390390
<see langword="true" /> if the <see cref="P:System.Windows.GridLength.GridUnitType" /> property is <see cref="F:System.Windows.GridUnitType.Auto" />; otherwise, <see langword="false" />.</value>
391391
<remarks>
392-
<format type="text/markdown"><![CDATA[
393-
394-
## Remarks
395-
The default <xref:System.Windows.GridLength.GridUnitType%2A> value is <xref:System.Windows.GridUnitType.Auto?displayProperty=nameWithType>. Therefore, this property returns `true` if you do not specify a <xref:System.Windows.GridUnitType> when creating the instance.
396-
392+
<format type="text/markdown"><![CDATA[
393+
394+
## Remarks
395+
The default <xref:System.Windows.GridLength.GridUnitType%2A> value is <xref:System.Windows.GridUnitType.Auto?displayProperty=nameWithType>. Therefore, this property returns `true` if you do not specify a <xref:System.Windows.GridUnitType> when creating the instance.
396+
397397
]]></format>
398398
</remarks>
399399
<altmember cref="T:System.Windows.GridUnitType" />

xml/System.Windows/NameScope.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@
300300
]]></format>
301301
</remarks>
302302
<exception cref="T:System.ArgumentException">
303-
<paramref name="key" /> is <see langword="null" />.</exception>
303+
<paramref name="item" /> is <see langword="null" />.</exception>
304304
</Docs>
305305
</Member>
306306
<Member MemberName="ContainsKey">

0 commit comments

Comments
 (0)