From f7f553396abbf1f3ffab1eb4ca4397aeb353e680 Mon Sep 17 00:00:00 2001
From: andy <andy@sarsoo.xyz>
Date: Sun, 31 Oct 2021 09:19:48 +0000
Subject: [PATCH] documentation

---
 Selector.CLI/WatcherService.cs                    |  2 +-
 Selector/Watcher/Interfaces/Events.cs             |  3 +++
 Selector/Watcher/Interfaces/IPlayerWatcher.cs     |  6 ++++++
 Selector/Watcher/Interfaces/IWatcher.cs           | 14 ++++++++++++++
 .../WatcherCollection/IWatcherCollection.cs       | 15 +++++++++++++++
 .../Watcher/WatcherCollection/WatcherContext.cs   |  4 ++++
 6 files changed, 43 insertions(+), 1 deletion(-)

diff --git a/Selector.CLI/WatcherService.cs b/Selector.CLI/WatcherService.cs
index 7474e97..8e15cdc 100644
--- a/Selector.CLI/WatcherService.cs
+++ b/Selector.CLI/WatcherService.cs
@@ -105,7 +105,7 @@ namespace Selector.CLI
                         break;
                     case WatcherType.Playlist:
                         throw new NotImplementedException("Playlist watchers not implemented");
-                        break;
+                        // break;
                 }
 
                 List<IConsumer> consumers = new();
diff --git a/Selector/Watcher/Interfaces/Events.cs b/Selector/Watcher/Interfaces/Events.cs
index 1326ad7..78544a3 100644
--- a/Selector/Watcher/Interfaces/Events.cs
+++ b/Selector/Watcher/Interfaces/Events.cs
@@ -6,6 +6,9 @@ namespace Selector
     public class ListeningChangeEventArgs: EventArgs {
         public CurrentlyPlayingContext Previous { get; set; }
         public CurrentlyPlayingContext Current { get; set; }
+        /// <summary>
+        /// Spotify Username
+        /// </summary>
         public string Username { get; set; }
         PlayerTimeline Timeline { get; set; }
 
diff --git a/Selector/Watcher/Interfaces/IPlayerWatcher.cs b/Selector/Watcher/Interfaces/IPlayerWatcher.cs
index 420c95f..7eecdc6 100644
--- a/Selector/Watcher/Interfaces/IPlayerWatcher.cs
+++ b/Selector/Watcher/Interfaces/IPlayerWatcher.cs
@@ -5,6 +5,9 @@ namespace Selector
 {
     public interface IPlayerWatcher: IWatcher
     {
+        /// <summary>
+        /// Track or episode changes
+        /// </summary>
         public event EventHandler<ListeningChangeEventArgs> ItemChange;
         public event EventHandler<ListeningChangeEventArgs> AlbumChange;
         public event EventHandler<ListeningChangeEventArgs> ArtistChange;
@@ -15,6 +18,9 @@ namespace Selector
         public event EventHandler<ListeningChangeEventArgs> DeviceChange;
         public event EventHandler<ListeningChangeEventArgs> PlayingChange;
 
+        /// <summary>
+        /// Last retrieved currently playing
+        /// </summary>
         public CurrentlyPlayingContext Live { get; }
         public PlayerTimeline Past { get; }
     }
diff --git a/Selector/Watcher/Interfaces/IWatcher.cs b/Selector/Watcher/Interfaces/IWatcher.cs
index 3cf92a4..4f9da00 100644
--- a/Selector/Watcher/Interfaces/IWatcher.cs
+++ b/Selector/Watcher/Interfaces/IWatcher.cs
@@ -5,9 +5,23 @@ namespace Selector
 {
     public interface IWatcher
     {
+        /// <summary>
+        /// Make single poll action on remote resource
+        /// </summary>
+        /// <param name="cancelToken">Token for early cancell</param>
+        /// <returns>awaitable task</returns>
         public Task WatchOne(CancellationToken cancelToken);
+        /// <summary>
+        /// Begin periodically polling with interval of PollPeriod
+        /// </summary>
+        /// <param name="cancelToken"></param>
+        /// <returns></returns>
         public Task Watch(CancellationToken cancelToken);
 
+        /// <summary>
+        /// Time interval in ms between polls from Watch()
+        /// </summary>
+        /// <value></value>
         public int PollPeriod { get; set; }
     }
 }
diff --git a/Selector/Watcher/WatcherCollection/IWatcherCollection.cs b/Selector/Watcher/WatcherCollection/IWatcherCollection.cs
index 084a440..526dd8a 100644
--- a/Selector/Watcher/WatcherCollection/IWatcherCollection.cs
+++ b/Selector/Watcher/WatcherCollection/IWatcherCollection.cs
@@ -7,10 +7,25 @@ namespace Selector
     public interface IWatcherCollection
     {
         public bool IsRunning { get; }
+        /// <summary>
+        /// Add watcher to collection, will start watcher if collection is running
+        /// </summary>
+        /// <param name="watcher">New watcher</param>
         public void Add(IWatcher watcher);
+        /// <summary>
+        /// Add watcher with given consumers to collection, will start watcher if collection is running
+        /// </summary>
+        /// <param name="watcher">New watcher</param>
+        /// <param name="consumers">Consumers to subscribe to new watcher</param>
         public void Add(IWatcher watcher, List<IConsumer> consumers);
 
+        /// <summary>
+        /// Start watcher collection
+        /// </summary>
         public void Start();
+        /// <summary>
+        /// Stop watcher collection
+        /// </summary>
         public void Stop();
     }
 }
diff --git a/Selector/Watcher/WatcherCollection/WatcherContext.cs b/Selector/Watcher/WatcherCollection/WatcherContext.cs
index 878e6cd..b02220d 100644
--- a/Selector/Watcher/WatcherCollection/WatcherContext.cs
+++ b/Selector/Watcher/WatcherCollection/WatcherContext.cs
@@ -12,6 +12,10 @@ namespace Selector
         public IWatcher Watcher { get; set; }
         private List<IConsumer> Consumers { get; set; } = new();
         public bool IsRunning { get; private set; }
+        /// <summary>
+        /// Reference to Watcher.Watch() task when running
+        /// </summary>
+        /// <value></value>
         public Task Task { get; set; }
         public CancellationTokenSource TokenSource { get; set; }