Add more comments

Author: arthurkehrwald

Runtime/MediaController/Core/BcpMessageHandler.cs

@@ -19,6 +19,14 @@ public interface IBcpMessageHandler
         public void Handle(BcpMessage message);
     }
 
+    /// <summary>
+    /// Abstract base for all message handlers. Implementations parse and provide a received event
+    /// for a specific type of message. Some messages are only sent by MPF if the media controller
+    /// previously requested them using their monitoring category. This is handled dynamically by
+    /// sending these requests when the first listener is added to the received event and canceling
+    /// them when the last listener is removed.
+    /// </summary>
+    /// <typeparam name="T">The type of message to handle</typeparam>
     public abstract class BcpMessageHandler<T> : IBcpMessageHandler
         where T : EventArgs
     {

Runtime/MediaController/Core/BcpMessageHandlers.cs

@@ -27,6 +27,9 @@
 
 namespace VisualPinball.Engine.Mpf.Unity.MediaController
 {
+    /// <summary>
+    /// Central hub for accessing all message handlers.
+    /// </summary>
     public class BcpMessageHandlers
     {
         public BcpMessageHandlers(BcpInterface bcpInterface)

Runtime/MediaController/Core/BcpServer.cs

@@ -28,6 +28,9 @@ public enum BcpConnectionState
         Disconnecting,
     };
 
+    /// <summary>
+    /// Sends and receives <c>BcpMessage</c> objects via TCP
+    /// </summary>
     public class BcpServer : IDisposable
     {
         public event EventHandler<StateChangedEventArgs<BcpConnectionState>> StateChanged;

Runtime/MediaController/Core/MpfEventRequester.cs

@@ -14,14 +14,20 @@
 
 namespace VisualPinball.Engine.Mpf.Unity.MediaController
 {
-    public class MpfEventRequester<TEvent>
+    /// <summary>
+    /// Used to request certain categories of messages to be sent from MPF. The categories are eiter
+    /// <c>MonitoringCategory</c> for various BCP messages or <c>string</c> to request arbitrary
+    /// MPF events to be sent as 'trigger' messages whenever they occur.
+    /// </summary>
+    /// <typeparam name="T">The type of each message category</typeparam>
+    public class MpfEventRequester<T>
     {
-        public delegate ISentMessage CreateMessage(TEvent @event);
+        public delegate ISentMessage CreateMessage(T @event);
 
         private readonly BcpInterface _bcpInterface;
         private readonly CreateMessage _createStartListeningMessage;
         private readonly CreateMessage _createStopListeningMessage;
-        private readonly Dictionary<TEvent, HashSet<object>> _listeners = new();
+        private readonly Dictionary<T, HashSet<object>> _listeners = new();
         private bool _canSendMonitoringRequests = false;
         private bool CanSendMonitoringRequests
         {
@@ -55,7 +61,7 @@ CreateMessage createStopListeningMessage
             _createStopListeningMessage = createStopListeningMessage;
         }
 
-        public void AddListener(object listener, TEvent @event)
+        public void AddListener(object listener, T @event)
         {
             if (_listeners.TryAdd(@event, new HashSet<object> { listener }))
             {
@@ -69,7 +75,7 @@ public void AddListener(object listener, TEvent @event)
                 );
         }
 
-        public void RemoveListener(object listener, TEvent @event)
+        public void RemoveListener(object listener, T @event)
         {
             if (
                 _listeners.TryGetValue(@event, out var listenersForThisEvent)
@@ -89,13 +95,13 @@ public void RemoveListener(object listener, TEvent @event)
                 );
         }
 
-        private void SendStartMonitoringRequest(TEvent @event)
+        private void SendStartMonitoringRequest(T @event)
         {
             var startListeningMsg = _createStartListeningMessage(@event);
             _bcpInterface.EnqueueMessage(startListeningMsg);
         }
 
-        private void SendStopMonitoringRequest(TEvent @event)
+        private void SendStopMonitoringRequest(T @event)
         {
             var stopListeningMsg = _createStopListeningMessage(@event);
             _bcpInterface.EnqueueMessage(stopListeningMsg);