Skip to content

Conversation

@ScrubN
Copy link
Contributor

@ScrubN ScrubN commented Jan 4, 2026

What does the pull request do?

Explicitly defines documentation in places where it is from an ambiguous base class/interface or where it is no longer valid due to inheritance changes.

What is the current behavior?

Certain methods, such as Dispatcher.Post(Action, DispatcherPriority), fail to resolve documentation with Rider/ReSharper.
Other methods, such as ExperimentalAcrylicMaterial.Invalidated, have dead inheritdoc links.

What is the updated/expected behavior with this PR?

Rider/ReSharper successfully resolves the documentation of the affected methods.

Checklist

@ScrubN
Copy link
Contributor Author

ScrubN commented Jan 4, 2026

While working on this PR, I think I found a bug - ExperimentalAcrylicMaterial.Invalidated is a dead inheritdoc link. Based on 9eaacef I think ExperimentalAcrylicMaterial is supposed to implement IAffectsRender, though it was implemented by the interface IMutableExperimentalAcrylicMaterial in this case, but in 64610c2 IAffectsRender was removed from the interface without being added to ExperimentalAcrylicMaterial.

If I am correct, do I have permission to add it to this PR? Or would a separate PR be preferred?

@cla-avalonia
Copy link
Collaborator

cla-avalonia commented Jan 4, 2026

  • All contributors have signed the CLA.

@ScrubN
Copy link
Contributor Author

ScrubN commented Jan 4, 2026

@cla-avalonia agree

@avaloniaui-bot
Copy link

You can test this PR using the following package version. 12.0.999-cibuild0061193-alpha. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

@ScrubN ScrubN marked this pull request as ready for review January 6, 2026 22:29
maxkatz6
maxkatz6 previously approved these changes Jan 7, 2026
@maxkatz6
Copy link
Member

maxkatz6 commented Jan 7, 2026

@ScrubN brush invalidation was removed from other brush types, and it seems to still be used here. Better to add simple xml doc specifically on this implementation, without changing any interfaces.

@avaloniaui-bot
Copy link

You can test this PR using the following package version. 12.0.999-cibuild0061251-alpha. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

@maxkatz6 maxkatz6 enabled auto-merge January 7, 2026 04:28
@avaloniaui-bot
Copy link

You can test this PR using the following package version. 12.0.999-cibuild0061257-alpha. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

@maxkatz6 maxkatz6 added this pull request to the merge queue Jan 7, 2026
Merged via the queue into AvaloniaUI:master with commit 73814df Jan 7, 2026
11 checks passed
@MrJul
Copy link
Member

MrJul commented Jan 7, 2026

Note: some fixes here actually introduced actual compiler warnings, see #20429.

@ScrubN
Copy link
Contributor Author

ScrubN commented Jan 7, 2026

Note: some fixes here actually introduced actual compiler warnings, see #20429.

Oh, I'm sorry! I didn't have the free space to fetch the missing workloads to test compile and ReSharper solution analysis didn't catch it.

@MrJul
Copy link
Member

MrJul commented Jan 7, 2026

No worries (we'll hopefully be enabling warnings as errors soon on CI).
Indeed ReSharper/Rider resolves those crefs correctly but the C# compiler doesn't.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants