Fix #1978 — Add XML docs for EventAggregator APIs#3375
Conversation
dansiegel
left a comment
There was a problem hiding this comment.
Requesting change: docs are inaccurate for non-UI contexts. The code throws () if SynchronizationContext is null. Please replace the note in (UIThread remarks) so it says this option requires the event aggregator to be constructed on a UI thread; it is not a fallback to publisher thread.
dansiegel
left a comment
There was a problem hiding this comment.
Requesting change: ThreadOption.UIThread docs are inaccurate for non-UI contexts. The code throws InvalidOperationException (Resources.EventAggregatorNotConstructedOnUIThread) if SynchronizationContext is null. Please replace the note in src/Prism.Events/ThreadOption.cs (UIThread remarks) so it says this option requires the event aggregator to be constructed on a UI thread; it is not a fallback to publisher thread.
Description of Change
Added missing XML documentation comments to event-related APIs to improve IntelliSense support and API discoverability.
This PR enhances developer guidance when using Prism's EventAggregator.
Bugs Fixed
API Changes
None
Behavioral Changes
None
Files Updated
PR Checklist