Add comments and simplify some of the new code

c-sharp/NetworkObjects/DataProvider.cs

@@ -8,14 +8,37 @@ namespace Paranext.DataProvider.NetworkObjects
 {
     internal abstract class DataProvider : NetworkObject
     {
+        // This is an internal class because nothing else should be instantiating it directly
+        private class MessageEventDataUpdated : MessageEventGeneric<bool>
+        {
+            // A parameterless constructor is required for serialization to work
+            // ReSharper disable once UnusedMember.Local
+            public MessageEventDataUpdated()
+                : base(Enum<EventType>.Null) { }
+
+            public MessageEventDataUpdated(Enum<EventType> eventType)
+                : base(eventType, true) { }
+        }
+
+        private readonly MessageEventDataUpdated _dataUpdatedEvent;
+
         protected DataProvider(string name, PapiClient papiClient)
             : base(papiClient)
         {
+            // "-data" is the prefix used by PAPI for data provider names
             DataProviderName = name + "-data";
+
+            // "onDidUpdate" is the event name used by PAPI for data providers to notify consumers of updates
+            var eventType = new Enum<EventType>($"{DataProviderName}:onDidUpdate");
+
+            _dataUpdatedEvent = new MessageEventDataUpdated(eventType);
         }
 
         protected string DataProviderName { get; }
 
+        /// <summary>
+        /// Register this data provider on the network so that other services can use it
+        /// </summary>
         public void RegisterDataProvider()
         {
             RegisterNetworkObject(DataProviderName, FunctionHandler);
@@ -47,10 +70,9 @@ private ResponseToRequest FunctionHandler(dynamic? request)
         /// <summary>
         /// Notify all processes on the network that this data provider has new data
         /// </summary>
-        protected void ReportDataUpdate()
+        protected void SendDataUpdateEvent()
         {
-            var dataUpdateEventType = new Enum<EventType>($"{DataProviderName}:onDidUpdate");
-            PapiClient.SendEvent(new DataUpdateEvent(dataUpdateEventType, true));
+            PapiClient.SendEvent(_dataUpdatedEvent);
         }
 
         /// <summary>

c-sharp/NetworkObjects/NetworkObject.cs

@@ -14,11 +14,18 @@ protected NetworkObject(PapiClient papiClient)
 
         protected PapiClient PapiClient { get; }
 
+        /// <summary>
+        /// Notify PAPI services we have a new network object they can use
+        /// </summary>
+        /// <param name="networkObjectName">Services access this network object using this name</param>
+        /// <param name="requestHandler">Function that will handle calls from services to this network object</param>
+        /// <exception cref="Exception">Throws if the network object could not be registered properly</exception>
         protected void RegisterNetworkObject(
             string networkObjectName,
             Func<dynamic, ResponseToRequest> requestHandler
         )
         {
+            // PAPI requires network objects to expose "get" and "function" requests
             var getReqType = new Enum<RequestType>($"object:{networkObjectName}.get");
             var functionReqType = new Enum<RequestType>($"object:{networkObjectName}.function");
 

c-sharp/NetworkObjects/TimeDataProvider.cs

@@ -1,27 +1,26 @@
-using System.Timers;
 using Paranext.DataProvider.MessageHandlers;
 using Paranext.DataProvider.MessageTransports;
 using SIL.Extensions;
 
 namespace Paranext.DataProvider.NetworkObjects
 {
+    /// <summary>
+    /// This is a sample data provider for demonstration purposes
+    /// </summary>
     internal class TimeDataProvider : DataProvider
     {
-        private readonly System.Timers.Timer _timer = new System.Timers.Timer(
-            TimeSpan.FromSeconds(1)
-        );
+        // Fire an event that says our "time data" updated once per second
+        private readonly System.Timers.Timer _timer = new(TimeSpan.FromSeconds(1));
 
         public TimeDataProvider(PapiClient papiClient)
             : base("current-time", papiClient) { }
 
-        private void TimerFired(object? state, ElapsedEventArgs args)
-        {
-            ReportDataUpdate();
-        }
-
         protected override void StartDataProvider()
         {
-            _timer.Elapsed += TimerFired;
+            _timer.Elapsed += (_, _) =>
+            {
+                SendDataUpdateEvent();
+            };
             _timer.AutoReset = true;
             _timer.Enabled = true;
         }

c-sharp/Properties/launchSettings.json

@@ -0,0 +1,11 @@
+{
+  "profiles": {
+    "ParanextDataProvider": {
+      "commandName": "Project"
+    },
+    "WSL": {
+      "commandName": "WSL2",
+      "distributionName": ""
+    }
+  }
+}