Add comments by AI

Back/skydiveLogs-api.DomainBusiness/StatsService.cs

@@ -38,6 +38,10 @@ namespace skydiveLogs_api.DomainBusiness
 
         #region Public Methods
 
+        /// <summary>
+        /// Retrieves a simple summary of all statistics.
+        /// </summary>
+        /// <returns>A SimpleSummary entity containing the simple summary statistics.</returns>
         public SimpleSummary GetSimpleSummary()
         {
             var allJumps = _jumpService.GetAllJumps();
@@ -58,6 +62,9 @@ namespace skydiveLogs_api.DomainBusiness
             return results;
         }
 
+        /// <summary>
+        /// Resets all statistics.
+        /// </summary>
         public void Reset()
         {
             _statsByAircraftService.Reset();
@@ -72,6 +79,10 @@ namespace skydiveLogs_api.DomainBusiness
             _statsForLastYearByJumpTypeService.Reset();
         }
 
+        /// <summary>
+        /// Retrieves statistics grouped by aircraft.
+        /// </summary>
+        /// <returns>A collection of Statistic entities containing aircraft statistics.</returns>
         public IEnumerable<Statistic> GetStatsByAircraft()
         {
             var tmp = _statsByAircraftService.GetStats();
@@ -82,6 +93,10 @@ namespace skydiveLogs_api.DomainBusiness
             })];
         }
 
+        /// <summary>
+        /// Retrieves statistics grouped by drop zone.
+        /// </summary>
+        /// <returns>A collection of Statistic entities containing drop zone statistics.</returns>
         public IEnumerable<Statistic> GetStatsByDz()
         {
             var tmp = _statsByDzService.GetStats();
@@ -92,6 +107,10 @@ namespace skydiveLogs_api.DomainBusiness
             })];
         }
 
+        /// <summary>
+        /// Retrieves statistics grouped by gear.
+        /// </summary>
+        /// <returns>A collection of Statistic entities containing gear statistics.</returns>
         public IEnumerable<Statistic> GetStatsByGear()
         {
             var tmp = _statsByGearService.GetStats();
@@ -102,6 +121,10 @@ namespace skydiveLogs_api.DomainBusiness
             })];
         }
 
+        /// <summary>
+        /// Retrieves statistics grouped by jump type.
+        /// </summary>
+        /// <returns>A collection of Statistic entities containing jump type statistics.</returns>
         public IEnumerable<Statistic> GetStatsByJumpType()
         {
             var tmp = _statsByJumpTypeService.GetStats();
@@ -112,6 +135,10 @@ namespace skydiveLogs_api.DomainBusiness
             })];
         }
 
+        /// <summary>
+        /// Retrieves statistics grouped by year.
+        /// </summary>
+        /// <returns>A collection of Statistic entities containing year statistics.</returns>
         public IEnumerable<Statistic> GetStatsByYear()
         {
             var tmp = _statsByYearService.GetStats();
@@ -122,6 +149,10 @@ namespace skydiveLogs_api.DomainBusiness
             })];
         }
 
+        /// <summary>
+        /// Retrieves statistics for the last month grouped by drop zone.
+        /// </summary>
+        /// <returns>A collection of Statistic entities containing last month drop zone statistics.</returns>
         public IEnumerable<Statistic> GetStatsForLastMonthByDz()
         {
             var tmp = _statsForLastMonthByDzService.GetStats();
@@ -132,6 +163,10 @@ namespace skydiveLogs_api.DomainBusiness
             })];
         }
 
+        /// <summary>
+        /// Retrieves statistics for the last month grouped by jump type.
+        /// </summary>
+        /// <returns>A collection of Statistic entities containing last month jump type statistics.</returns>
         public IEnumerable<Statistic> GetStatsForLastMonthByJumpType()
         {
             var tmp = _statsForLastMonthByJumpTypeService.GetStats();
@@ -142,6 +177,10 @@ namespace skydiveLogs_api.DomainBusiness
             })];
         }
 
+        /// <summary>
+        /// Retrieves statistics for the last year grouped by drop zone.
+        /// </summary>
+        /// <returns>A collection of Statistic entities containing last year drop zone statistics.</returns>
         public IEnumerable<Statistic> GetStatsForLastYearByDz()
         {
             var tmp = _statsForLastYearByDzService.GetStats();
@@ -152,6 +191,10 @@ namespace skydiveLogs_api.DomainBusiness
             })];
         }
 
+        /// <summary>
+        /// Retrieves statistics for the last year grouped by jump type.
+        /// </summary>
+        /// <returns>A collection of Statistic entities containing last year jump type statistics.</returns>
         public IEnumerable<Statistic> GetStatsForLastYearByJumpType()
         {
             var tmp = _statsForLastYearByJumpTypeService.GetStats();
@@ -162,6 +205,10 @@ namespace skydiveLogs_api.DomainBusiness
             })];
         }
 
+        /// <summary>
+        /// Retrieves statistics by year grouped with jump type.
+        /// </summary>
+        /// <returns>A collection of Statistic entities containing yearly jump type statistics.</returns>
         public IEnumerable<Statistic> GetStatsByYearByJumpType()
         {
             var tmp = _statsByYearByJumpTypeService.GetStats();
@@ -191,4 +238,4 @@ namespace skydiveLogs_api.DomainBusiness
 
         #endregion Private Fields
     }
-}
+}