Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix mismatched paramrefs (System.Xml/Xaml/Windows) #11157

Merged
merged 3 commits into from
Apr 1, 2025
Merged

Fix mismatched paramrefs (System.Xml/Xaml/Windows) #11157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82c9125
system.xml
gewarren Mar 31, 2025
1f941be
system.xaml
gewarren Mar 31, 2025
7853662
system.windows
gewarren Mar 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions xml/System.Windows/DataObject.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2319,7 +2319,7 @@

</description></item><item><term> E_NOTIMPL

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

</description></item><item><term> OLE_S_USEREG

Expand Down Expand Up @@ -2387,15 +2387,15 @@

</description></item><item><term> DATA_S_SAMEFORMATETC

</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.
</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.

</description></item><item><term> DV_E_LINDEX

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

</description></item><item><term> DV_E_FORMATETC

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

</description></item><item><term> OLE_E_NOTRUNNING

Expand Down Expand Up @@ -2563,7 +2563,7 @@

</description></item><item><term> DV_E_FORMATETC

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

</description></item><item><term> DV_E_TYMED

Expand Down
80 changes: 40 additions & 40 deletions xml/System.Windows/DependencyObjectType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@
<Docs>
<summary>Implements an underlying type cache for all <see cref="T:System.Windows.DependencyObject" /> derived types.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<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.
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>.
<format type="text/markdown"><![CDATA[

## Remarks
<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.

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>.

]]></format>
</remarks>
<altmember cref="T:System.Windows.DependencyProperty" />
Expand Down Expand Up @@ -99,19 +99,19 @@
<summary>Returns a <see cref="T:System.Windows.DependencyObjectType" /> that represents a given system (CLR) type.</summary>
<returns>A <see cref="T:System.Windows.DependencyObjectType" /> that represents the system (CLR) type.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
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>.
## Examples
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.
<format type="text/markdown"><![CDATA[

## Remarks
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>.



## Examples
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.

:::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyObjectType/FromSystemType/page3.xaml.cs" id="Snippetdotfromsystemtype":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/PropertiesOvwSupport/visualbasic/page3.xaml.vb" id="Snippetdotfromsystemtype":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/PropertiesOvwSupport/visualbasic/page3.xaml.vb" id="Snippetdotfromsystemtype":::

]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -143,11 +143,11 @@
<summary>Returns the hash code for this <see cref="T:System.Windows.DependencyObjectType" />.</summary>
<returns>A 32-bit signed integer hash code.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This implementation is linked to the value of the <xref:System.Windows.DependencyObjectType.Id%2A> property.
<format type="text/markdown"><![CDATA[

## Remarks
This implementation is linked to the value of the <xref:System.Windows.DependencyObjectType.Id%2A> property.

]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -184,11 +184,11 @@
<summary>Gets a zero-based unique identifier for constant-time array lookup operations.</summary>
<value>An internal identifier.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Do not use for general hashing functions. There is no guarantee on this value. It can vary between application runs.
<format type="text/markdown"><![CDATA[

## Remarks
Do not use for general hashing functions. There is no guarantee on this value. It can vary between application runs.

]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -222,13 +222,13 @@
<param name="dependencyObject">The object to compare with the current <see cref="T:System.Windows.DependencyObjectType" />.</param>
<summary>Determines whether the specified object is an instance of the current <see cref="T:System.Windows.DependencyObjectType" />.</summary>
<returns>
<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>
<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>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Objects of the exact same type return `true`.
<format type="text/markdown"><![CDATA[

## Remarks
Objects of the exact same type return `true`.

]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -292,11 +292,11 @@
<summary>Gets the name of the represented common language runtime (CLR) system type.</summary>
<value>The name of the represented CLR system type.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
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>.
<format type="text/markdown"><![CDATA[

## Remarks
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>.

]]></format>
</remarks>
<altmember cref="T:System.Windows.DependencyProperty" />
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Windows/FrameworkElement.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,7 @@
<returns>The actual size used.</returns>
<remarks>To be added.</remarks>
<block subset="none" type="overrides">
<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.
<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.

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>
</block>
Expand Down Expand Up @@ -5896,7 +5896,7 @@
<Docs>
<param name="resourceKey">The key identifier of the resource to be found.</param>
<summary>Searches for a resource with the specified key, and returns that resource if found.</summary>
<returns>The found resource, or <see langword="null" /> if no resource with the provided <paramref name="key" /> is found.</returns>
<returns>The found resource, or <see langword="null" /> if no resource with the provided <paramref name="resourceKey" /> is found.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down
74 changes: 37 additions & 37 deletions xml/System.Windows/GridLength.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,43 +33,43 @@
<Docs>
<summary>Represents the length of elements that explicitly support <see cref="F:System.Windows.GridUnitType.Star" /> unit types.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
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.
<a name="xamlAttributeUsage_GridLength"></a>
## XAML Attribute Usage
<format type="text/markdown"><![CDATA[

## Remarks
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.

<a name="xamlAttributeUsage_GridLength"></a>
## XAML Attribute Usage

```xaml
<object property="doubleLength"/>
<object property="doubleLength"/>
```

-or-

```xaml
<object property="autoValue"/>
```
<a name="xamlValues_GridLength"></a>
## XAML Values
*doubleLength*
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).
*autoValue*
The element's length, described by either the value Auto or *. See <xref:System.Windows.GridUnitType> for more information on the values Auto and *.
*qualifiedDouble*
A *double* value as described above for any of the measures, followed by one of the following unit declaration strings: `px`, `in`, `cm`, `pt`.
`px` (default) is device-independent units (1/96th inch per unit)
`in` is inches; 1in==96px
`cm` is centimeters; 1cm==(96/2.54) px
`pt` is points; 1pt==(96/72) px
<object property="autoValue"/>
```

<a name="xamlValues_GridLength"></a>
## XAML Values
*doubleLength*
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).

*autoValue*
The element's length, described by either the value Auto or *. See <xref:System.Windows.GridUnitType> for more information on the values Auto and *.

*qualifiedDouble*
A *double* value as described above for any of the measures, followed by one of the following unit declaration strings: `px`, `in`, `cm`, `pt`.

`px` (default) is device-independent units (1/96th inch per unit)

`in` is inches; 1in==96px

`cm` is centimeters; 1cm==(96/2.54) px

`pt` is points; 1pt==(96/72) px

]]></format>
</remarks>
<altmember cref="T:System.Windows.GridUnitType" />
Expand Down Expand Up @@ -117,7 +117,7 @@
<summary>Initializes a new instance of the <see cref="T:System.Windows.GridLength" /> structure using the specified absolute value in pixels.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<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>
<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>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -389,11 +389,11 @@
<value>
<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>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
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.
<format type="text/markdown"><![CDATA[

## Remarks
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.

]]></format>
</remarks>
<altmember cref="T:System.Windows.GridUnitType" />
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Windows/NameScope.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="key" /> is <see langword="null" />.</exception>
<paramref name="item" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="ContainsKey">
Expand Down
Loading