Fix ambiguous and dead inheritdoc links (#20397)
* Specifiy explicit interface method when inheritdoc has ambiguous base candidates
* Explicitly write out Dispatcher.Post(Action,DispatcherPriority) documentation
* Move Post(Action,DispatcherPriority) next to Post(SendOrPostCallback,object?,DispatcherPriority) for clarity
* Fix Layoutable.ChildDesiredSizeChanged
Documentation sourced from 0e2cee8810
* Add specific invalidation xml doc to ExperimentalAcrylicMaterial.Invalidated
* Fix typos in FallbackColor xml doc
---------
Co-authored-by: Max Katz <maxkatz6@outlook.com>
This commit is contained in:
@@ -271,7 +271,7 @@ namespace Avalonia.Animation
|
||||
IDisposable IAnimation.Apply(Animatable control, IClock? clock, IObservable<bool> match, Action? onComplete)
|
||||
=> Apply(control, clock, match, onComplete);
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <inheritdoc cref="IAnimation.Apply"/>
|
||||
internal IDisposable Apply(Animatable control, IClock? clock, IObservable<bool> match, Action? onComplete)
|
||||
{
|
||||
var (animators, subscriptions) = InterpretKeyframes(control);
|
||||
@@ -320,7 +320,7 @@ namespace Avalonia.Animation
|
||||
public Task RunAsync(Animatable control, CancellationToken cancellationToken = default) =>
|
||||
RunAsync(control, null, cancellationToken);
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <inheritdoc cref="IAnimation.RunAsync"/>
|
||||
internal Task RunAsync(Animatable control, IClock? clock)
|
||||
{
|
||||
return RunAsync(control, clock, default);
|
||||
@@ -329,7 +329,7 @@ namespace Avalonia.Animation
|
||||
Task IAnimation.RunAsync(Animatable control, IClock? clock, CancellationToken cancellationToken)
|
||||
=> RunAsync(control, clock, cancellationToken);
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <inheritdoc cref="IAnimation.RunAsync"/>
|
||||
internal Task RunAsync(Animatable control, IClock? clock, CancellationToken cancellationToken)
|
||||
{
|
||||
if (cancellationToken.IsCancellationRequested)
|
||||
|
||||
@@ -78,7 +78,7 @@ namespace Avalonia.Animation
|
||||
set { SetAndRaise(EasingProperty, ref _easing, value); }
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <inheritdoc cref="ITransition.Property"/>
|
||||
[DisallowNull]
|
||||
public AvaloniaProperty? Property
|
||||
{
|
||||
|
||||
@@ -59,10 +59,10 @@ namespace Avalonia.Collections
|
||||
/// </summary>
|
||||
public event PropertyChangedEventHandler? PropertyChanged;
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <inheritdoc cref="IDictionary{TKey,TValue}.Count"/>
|
||||
public int Count => _inner.Count;
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <inheritdoc cref="IDictionary{TKey,TValue}.IsReadOnly"/>
|
||||
public bool IsReadOnly => false;
|
||||
|
||||
/// <inheritdoc/>
|
||||
@@ -131,7 +131,7 @@ namespace Avalonia.Collections
|
||||
NotifyAdd(key, value);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <inheritdoc cref="IDictionary{TKey,TValue}.Clear"/>
|
||||
public void Clear()
|
||||
{
|
||||
var old = _inner;
|
||||
@@ -152,7 +152,7 @@ namespace Avalonia.Collections
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <inheritdoc cref="IDictionary{TKey,TValue}.ContainsKey"/>
|
||||
public bool ContainsKey(TKey key) => _inner.ContainsKey(key);
|
||||
|
||||
/// <inheritdoc/>
|
||||
@@ -189,8 +189,9 @@ namespace Avalonia.Collections
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <inheritdoc cref="IDictionary{TKey,TValue}.TryGetValue"/>
|
||||
public bool TryGetValue(TKey key, [MaybeNullWhen(false)] out TValue value) => _inner.TryGetValue(key, out value);
|
||||
|
||||
/// <inheritdoc/>
|
||||
IEnumerator IEnumerable.GetEnumerator() => _inner.GetEnumerator();
|
||||
|
||||
|
||||
@@ -470,7 +470,10 @@ namespace Avalonia.Layout
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <summary>
|
||||
/// Called when a child control's desired size changes.
|
||||
/// </summary>
|
||||
/// <param name="control">The child control.</param>
|
||||
internal void ChildDesiredSizeChanged(Layoutable control)
|
||||
{
|
||||
if (!_measuring)
|
||||
|
||||
@@ -78,7 +78,9 @@ namespace Avalonia.Media
|
||||
public static readonly StyledProperty<Color> FallbackColorProperty =
|
||||
AvaloniaProperty.Register<ExperimentalAcrylicMaterial, Color>(nameof(FallbackColor));
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <summary>
|
||||
/// Raised when any of the material's visual properties change.
|
||||
/// </summary>
|
||||
public event EventHandler? Invalidated;
|
||||
|
||||
/// <summary>
|
||||
@@ -110,7 +112,7 @@ namespace Avalonia.Media
|
||||
|
||||
/// <summary>
|
||||
/// Gets or Sets the Fallback Color.
|
||||
/// This is used on rendering plaforms that dont support acrylic.
|
||||
/// This is used on rendering platforms that don't support acrylic.
|
||||
/// </summary>
|
||||
public Color FallbackColor
|
||||
{
|
||||
|
||||
@@ -49,7 +49,7 @@ namespace Avalonia.Media
|
||||
set { SetValue(SpreadMethodProperty, value); }
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <inheritdoc cref="IGradientBrush.GradientStops"/>
|
||||
[Content]
|
||||
public GradientStops GradientStops
|
||||
{
|
||||
|
||||
@@ -541,13 +541,6 @@ public partial class Dispatcher
|
||||
return result;
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public void Post(Action action, DispatcherPriority priority = default)
|
||||
{
|
||||
_ = action ?? throw new ArgumentNullException(nameof(action));
|
||||
InvokeAsyncImpl(new DispatcherOperation(this, priority, action, true), CancellationToken.None);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Executes the specified Func<Task> asynchronously on the
|
||||
/// thread that the Dispatcher was created on
|
||||
@@ -615,6 +608,17 @@ public partial class Dispatcher
|
||||
return InvokeAsync<Task<TResult>>(action, priority).GetTask().Unwrap();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Posts an action that will be invoked on the dispatcher thread.
|
||||
/// </summary>
|
||||
/// <param name="action">The method.</param>
|
||||
/// <param name="priority">The priority with which to invoke the method.</param>
|
||||
public void Post(Action action, DispatcherPriority priority = default)
|
||||
{
|
||||
_ = action ?? throw new ArgumentNullException(nameof(action));
|
||||
InvokeAsyncImpl(new DispatcherOperation(this, priority, action, true), CancellationToken.None);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Posts an action that will be invoked on the dispatcher thread.
|
||||
/// </summary>
|
||||
|
||||
@@ -77,14 +77,14 @@ namespace Avalonia.Controls
|
||||
private set => SetAndRaise(ScrollProperty, ref _scroll, value);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <inheritdoc cref="SelectingItemsControl.SelectedItems"/>
|
||||
public new IList? SelectedItems
|
||||
{
|
||||
get => base.SelectedItems;
|
||||
set => base.SelectedItems = value;
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <inheritdoc cref="SelectingItemsControl.Selection"/>
|
||||
public new ISelectionModel Selection
|
||||
{
|
||||
get => base.Selection;
|
||||
|
||||
@@ -43,7 +43,7 @@ namespace Avalonia.Controls
|
||||
AccessKeyHandler.AccessKeyPressedEvent.AddClassHandler<Menu>(OnAccessKeyPressed);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <inheritdoc cref="IMainMenu.Close"/>
|
||||
public override void Close()
|
||||
{
|
||||
if (!IsOpen)
|
||||
@@ -66,7 +66,7 @@ namespace Avalonia.Controls
|
||||
});
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
/// <inheritdoc cref="IMainMenu.Open"/>
|
||||
public override void Open()
|
||||
{
|
||||
if (IsOpen)
|
||||
|
||||
Reference in New Issue
Block a user