Skip to content
This repository was archived by the owner on Jun 21, 2023. It is now read-only.

Commit 8d68827

Browse files
committed
Document INotification service and dispatcher
1 parent 7f353b6 commit 8d68827

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

src/GitHub.Exports/Services/INotificationDispatcher.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ public Notification(string message, NotificationType type, ICommand command = nu
2424
}
2525
}
2626

27+
/// <summary>
28+
/// Dispatches notifications sent to the <see cref="INotificationService"/>
29+
/// to registered listeners.
30+
/// </summary>
2731
public interface INotificationDispatcher : INotificationService
2832
{
2933
IObservable<Notification> Listen();

src/GitHub.Exports/Services/INotificationService.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
namespace GitHub.Services
44
{
5+
/// <summary>
6+
/// Service to broadcast messages, warnings and errors. Listeners
7+
/// can receive them by registering with <see cref="INotificationDispatcher"/>
8+
/// </summary>
59
public interface INotificationService
610
{
711
void ShowMessage(string message);

0 commit comments

Comments
 (0)