Add documentation

DotNetBackendTraining · Mar 16, 2024 · 1d22f72 · 1d22f72
1 parent 89d013d
commit 1d22f72
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/RealTimeWeatherMonitoringApp/Application/Service/AutoParsingService.cs b/RealTimeWeatherMonitoringApp/Application/Service/AutoParsingService.cs
@@ -4,6 +4,11 @@
 
 namespace RealTimeWeatherMonitoringApp.Application.Service;
 
+/// <summary>
+/// A simple iterative approach,
+/// tries all strategies one by one until it finds a valid parsing strategy and returns the result.
+/// </summary>
+/// <typeparam name="TResult">Parsed data type</typeparam>
 public class AutoParsingService<TResult> : IAutoParsingService<TResult>
 {
     private readonly List<IParsingStrategy<TResult>> _strategies = [];

diff --git a/RealTimeWeatherMonitoringApp/Application/Service/BotEventDispatcher.cs b/RealTimeWeatherMonitoringApp/Application/Service/BotEventDispatcher.cs
@@ -4,6 +4,9 @@
 
 namespace RealTimeWeatherMonitoringApp.Application.Service;
 
+/// <summary>
+/// Listens for published bot events, and notifies its subscribers about them.
+/// </summary>
 public class BotEventDispatcher : IBotNotificationService, IBotPublishingService
 {
     public event EventHandler<BotEventArgs>? OnBotNotification;

diff --git a/RealTimeWeatherMonitoringApp/Application/Service/MonitoringService.cs b/RealTimeWeatherMonitoringApp/Application/Service/MonitoringService.cs
@@ -3,6 +3,10 @@
 
 namespace RealTimeWeatherMonitoringApp.Application.Service;
 
+/// <summary>
+/// A simple data receiver that notifies its subscribers about any new data it receives.
+/// </summary>
+/// <typeparam name="TData">Monitored data type</typeparam>
 public class MonitoringService<TData> : IDataReceiver<TData>, IDataChangeNotifier<TData>
 {
     public void Receive(TData data) =>