Skip to content

Commit

Permalink
Fixed doc warnings reported by #393 (comment)
Browse files Browse the repository at this point in the history
  • Loading branch information
Arlodotexe authored and michael-hawker committed Aug 21, 2024
1 parent c870c7c commit c2bb98c
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/windows/Converters/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Converts a source string from the App resources and returns its value, if found.

## StringFormatConverter

This allows you to format a string property upon binding wrapping [string.Format](/dotnet/api/system.string.format?view=netstandard-2.0).
This allows you to format a string property upon binding wrapping [string.Format](/dotnet/api/system.string.format?view=netstandard-2.0&preserve-view=true).
It only allows for a single input value (the binding string), but can be formatted with the regular string.Format
methods.

Expand Down
2 changes: 1 addition & 1 deletion docs/windows/Extensions/DispatcherQueueExtensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ int someOtherValue = await dispatcherQueue.EnqueueAsync(async () =>
});
```

## Migrating from [`DispatcherHelper`](..\helpers\DispatcherHelper.md)
## Migrating from DispatcherHelper

The [`CoreDispatcher`](/uwp/api/windows.ui.core.coredispatcher) is being deprecated (and it will no longer work with XAML Islands or WinUI 3) and should no longer be used, as it had a number of limitations. Specifically, it relied on the assumption that each window had its own UI thread tied to it, which is not always the case. The new `DispatcherQueue` instead can be used going forwards, and it requires some changes in code that was previously relying on `CoreDispatcher` and `DispatcherHelper`. Specifically, a background thread can no longer retrieve the `CoreDispatcher` by just accessing the dispatcher associated to the "main window" for the application, because this concept does not apply anymore. Instead, a `DispatcherQueue` instance needs to be retrieved on the UI thread and cached for later use in a background thread.

Expand Down
2 changes: 1 addition & 1 deletion docs/windows/Extensions/FrameworkElementExtensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Here is how you can easily set a custom cursor type for a target `FrameworkEleme
```

> [!NOTE]
> Even though Microsoft recommends in [UWP Design guidelines](/uwp/input-and-devices/mouse-interactions#cursors) hover effects instead of custom cursors over interactive elements, custom cursors can be useful in some specific scenarios.
> Even though Microsoft recommends in [UWP Design guidelines](/windows/apps/design/input/mouse-interactions#cursors) hover effects instead of custom cursors over interactive elements, custom cursors can be useful in some specific scenarios.
> [!WARNING]
> Because the UWP framework does not support metadata on attached properties, specifically the [`FrameworkPropertyMetadata.Inherits`](/dotnet/api/system.windows.frameworkpropertymetadata.-ctor#System_Windows_FrameworkPropertyMetadata__ctor_System_Object_System_Windows_FrameworkPropertyMetadataOptions_System_Windows_PropertyChangedCallback_System_Windows_CoerceValueCallback_) flag, the `Cursor` property might not work properly in some very specific XAML layout scenarios when combining nested `FrameworkElement`-s with different `CoreCursorType` values set on them.
Expand Down
2 changes: 1 addition & 1 deletion docs/windows/Extensions/ShadowAnimations.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ icon: Assets/ShadowAnimation.png

# Shadow animations

Either type of Attached Shadow can be easily animated using the Toolkit's [`AnimationSet`](../animations/AnimationSet.md) api. These provide an easy XAML based way to animate a wide variety of elements, including a variety of shadow properties. They can also be animated with any other composition animation technique in code-behind as well using either the [`AnimationBuilder`](../animations/AnimationBuilder.md) or built-in composition animations.
Either type of Attached Shadow can be easily animated using the Toolkit's [`AnimationSet`](../animations/AnimationSet.md) api. These provide an easy XAML based way to animate a wide variety of elements, including a variety of shadow properties. They can also be animated with any other composition animation technique in code-behind as well using either the [`AnimationBuilder`](../Behaviors/AnimationSet.md) or built-in composition animations.

> **Platform APIs:** `BlurRadiusDropShadowAnimation`, `ColorDropShadowAnimation`, `OffsetDropShadowAnimation`, `OpacityDropShadowAnimation`
Expand Down
2 changes: 1 addition & 1 deletion docs/windows/Sizers/GridSplitter.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GridSplitter
author: michael-hawker
description:The GridSplitter control provides an easy-to-use Splitter that redistributes space between columns or rows of a Grid Control.
description: The GridSplitter control provides an easy-to-use Splitter that redistributes space between columns or rows of a Grid Control.
keywords: ContentSizer, SizerBase, Control, Layout, Expander
dev_langs:
- csharp
Expand Down

0 comments on commit c2bb98c

Please sign in to comment.