Back/skydiveLogs-api.Infrastructure/AircraftRepository.cs

@@ -1,20 +1,29 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
 using LiteDB;
 using skydiveLogs_api.Domain;
 using skydiveLogs_api.DomainService.Repositories;
 using skydiveLogs_api.Infrastructure.Interfaces;
-using System.Collections.Generic;
-using System.Linq;
 
 namespace skydiveLogs_api.Infrastructure
 {
+    /// <summary>
+    /// Repository class for managing aircraft data in the database.
+    /// Provides operations to add, retrieve, count, and update aircraft records.
+    /// </summary>
     public class AircraftRepository : IAircraftRepository
     {
         #region Public Constructors
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="AircraftRepository"/> class
+        /// Initializes a new instance of the <see cref="AircraftRepository"/> class.
         /// </summary>
-        /// <param name="dataProvider">The data provider to use for data access</param>
+        /// <param name="dataProvider">The data provider used for database access operations</param>
+        /// <remarks>
+        /// This constructor initializes the repository with a reference to the data provider
+        /// and sets up the collection for aircraft data operations.
+        /// </remarks>
         public AircraftRepository(IDataProvider dataProvider)
         {
             _dataProvider = dataProvider;
@@ -26,10 +35,14 @@ namespace skydiveLogs_api.Infrastructure
         #region Public Methods
 
         /// <summary>
-        /// Adds a new aircraft to the database
+        /// Adds a new aircraft to the database.
         /// </summary>
-        /// <param name="newAircraft">The aircraft instance to add</param>
-        /// <returns>The number of rows affected (0 if insert failed)</returns>
+        /// <param name="newAircraft">The aircraft instance to insert into the database</param>
+        /// <returns>The number of rows affected. Returns 0 if the insert operation failed.</returns>
+        /// <remarks>
+        /// Attempts to insert the new aircraft into the database using LiteDB.
+        /// If an exception occurs during insertion, the method returns 0.
+        /// </remarks>
         public int Add(Aircraft newAircraft)
         {
             int result;
@@ -48,38 +61,54 @@ namespace skydiveLogs_api.Infrastructure
         }
 
         /// <summary>
-        /// Retrieves all aircraft from the database
+        /// Retrieves all aircraft from the database.
         /// </summary>
-        /// <returns>A collection of all aircraft instances</returns>
+        /// <returns>An enumerable collection containing all aircraft instances stored in the database</returns>
+        /// <remarks>
+        /// Queries the aircraft collection and retrieves all records,
+        /// then converts the result to a List for enumeration.
+        /// </remarks>
         public IEnumerable<Aircraft> GetAll()
         {
             return _col.FindAll().ToList();
         }
 
         /// <summary>
-        /// Retrieves an aircraft by its unique identifier
+        /// Retrieves an aircraft by its unique identifier.
         /// </summary>
-        /// <param name="id">The unique identifier of the aircraft</param>
-        /// <returns>The aircraft instance or null if not found</returns>
+        /// <param name="id">The unique identifier of the aircraft to retrieve</param>
+        /// <returns>The aircraft instance if found, otherwise null</returns>
+        /// <remarks>
+        /// Searches the aircraft collection for a record with the specified ID
+        /// and returns the found aircraft or null if no match exists.
+        /// </remarks>
         public Aircraft GetById(int id)
         {
             return _col.FindById(new BsonValue(id));
         }
 
         /// <summary>
-        /// Gets the total count of aircraft in the database
+        /// Gets the total count of aircraft in the database.
         /// </summary>
-        /// <returns>The total number of aircraft</returns>
+        /// <returns>The total number of aircraft stored in the database</returns>
+        /// <remarks>
+        /// This method is not currently implemented and throws
+        /// a <see cref="NotImplementedException"/> when called.
+        /// </remarks>
         public int GetCount()
         {
-            throw new System.NotImplementedException();
+            throw new NotImplementedException();
         }
 
         /// <summary>
-        /// Updates an existing aircraft in the database
+        /// Updates an existing aircraft in the database.
         /// </summary>
-        /// <param name="aircraft">The aircraft instance to update</param>
-        /// <returns>True if the update was successful, false otherwise</returns>
+        /// <param name="aircraft">The aircraft instance containing the updated data</param>
+        /// <returns><see langword="true"/> if the update was successful; otherwise, <see langword="false"/></returns>
+        /// <remarks>
+        /// Updates the aircraft record in the database with the provided aircraft instance.
+        /// The method returns the result of the underlying LiteDB update operation.
+        /// </remarks>
         public bool Update(Aircraft aircraft)
         {
             return _col.Update(aircraft);
@@ -89,7 +118,14 @@ namespace skydiveLogs_api.Infrastructure
 
         #region Private Fields
 
+        /// <summary>
+        /// The LiteDB collection for aircraft records.
+        /// </summary>
         private readonly ILiteCollection<Aircraft> _col;
+
+        /// <summary>
+        /// The data provider used for database access operations.
+        /// </summary>
         private readonly IDataProvider _dataProvider;
 
         #endregion Private Fields

Back/skydiveLogs-api.Infrastructure/DropZoneRepository.cs

@@ -1,20 +1,33 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
 using LiteDB;
 using skydiveLogs_api.Domain;
 using skydiveLogs_api.DomainService.Repositories;
 using skydiveLogs_api.Infrastructure.Interfaces;
-using System.Collections.Generic;
-using System.Linq;
 
 namespace skydiveLogs_api.Infrastructure
 {
+    /// <summary>
+    /// Repository class for managing drop zone data in the database.
+    /// Provides operations to add, retrieve, count, and update drop zone records.
+    /// </summary>
+    /// <remarks>
+    /// This repository interacts with LiteDB to perform CRUD operations on drop zones.
+    /// </remarks>
     public class DropZoneRepository : IDropZoneRepository
     {
         #region Public Constructors
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="DropZoneRepository"/> class
+        /// Initializes a new instance of the <see cref="DropZoneRepository"/> class.
         /// </summary>
-        /// <param name="dataProvider">The data provider to use for data access</param>
+        /// <param name="dataProvider">The data provider used for database access operations.</param>
+        /// <remarks>
+        /// This constructor initializes the repository with a reference to the data provider
+        /// and sets up the collection for drop zone data operations.
+        /// The data provider manages the underlying LiteDatabase connection.
+        /// </remarks>
         public DropZoneRepository(IDataProvider dataProvider)
         {
             _dataProvider = dataProvider;
@@ -26,10 +39,15 @@ namespace skydiveLogs_api.Infrastructure
         #region Public Methods
 
         /// <summary>
-        /// Adds a new drop zone to the database
+        /// Adds a new drop zone to the database.
         /// </summary>
-        /// <param name="newDropZone">The drop zone instance to add</param>
-        /// <returns>The number of rows affected (0 if insert failed)</returns>
+        /// <param name="newDropZone">The drop zone instance to insert into the database.</param>
+        /// <returns>The number of rows affected. Returns 0 if the insert operation failed.</returns>
+        /// <remarks>
+        /// Attempts to insert the new drop zone into the database using LiteDB.
+        /// If an exception occurs during insertion, the method returns 0.
+        /// The returned value indicates the number of records affected by the insert operation.
+        /// </remarks>
         public int Add(DropZone newDropZone)
         {
             int result;
@@ -48,38 +66,60 @@ namespace skydiveLogs_api.Infrastructure
         }
 
         /// <summary>
-        /// Retrieves all drop zones from the database
+        /// Retrieves all drop zones from the database.
         /// </summary>
-        /// <returns>A collection of all drop zone instances</returns>
+        /// <returns>An enumerable collection containing all drop zone instances stored in the database.</returns>
+        /// <remarks>
+        /// Queries the drop zone collection and retrieves all records,
+        /// then converts the result to a List for enumeration.
+        /// Returns an empty list if no drop zones exist in the database.
+        /// </remarks>
         public IEnumerable<DropZone> GetAll()
         {
             return _col.FindAll().ToList();
         }
 
         /// <summary>
-        /// Retrieves a drop zone by its unique identifier
+        /// Retrieves a drop zone by its unique identifier.
         /// </summary>
-        /// <param name="id">The unique identifier of the drop zone</param>
-        /// <returns>The drop zone instance or null if not found</returns>
+        /// <param name="id">The unique identifier of the drop zone to retrieve.</param>
+        /// <returns>The drop zone instance if found, otherwise null.</returns>
+        /// <remarks>
+        /// Searches the drop zone collection for a record with the specified ID
+        /// and returns the found drop zone or null if no match exists.
+        /// Use <see cref="GetAll"/> to retrieve all drop zones or filter by criteria.
+        /// </remarks>
         public DropZone GetById(int id)
         {
             return _col.FindById(new BsonValue(id));
         }
 
         /// <summary>
-        /// Gets the total count of drop zones in the database
+        /// Gets the total count of drop zones in the database.
         /// </summary>
-        /// <returns>The total number of drop zones</returns>
+        /// <returns>The total number of drop zones stored in the database.</returns>
+        /// <remarks>
+        /// This method is not currently implemented and throws
+        /// a <see cref="NotImplementedException"/> when called.
+        /// Implement this method to retrieve the count of all drop zones.
+        /// </remarks>
+        /// <exception cref="NotImplementedException">Thrown when the count is requested.</exception>
         public int GetCount()
         {
-            throw new System.NotImplementedException();
+            throw new NotImplementedException();
         }
 
         /// <summary>
-        /// Updates an existing drop zone in the database
+        /// Updates an existing drop zone in the database.
         /// </summary>
-        /// <param name="dropZone">The drop zone instance to update</param>
-        /// <returns>True if the update was successful, false otherwise</returns>
+        /// <param name="dropZone">The drop zone instance containing the updated data.</param>
+        /// <returns><see langword="true"/> if the update was successful; otherwise, <see langword="false"/>.</returns>
+        /// <remarks>
+        /// Updates the drop zone record in the database with the provided drop zone instance.
+        /// The drop zone must have a valid ID to be updated.
+        /// The method returns the result of the underlying LiteDB update operation.
+        /// If the drop zone does not exist, the update operation will return 0.
+        /// </remarks>
         public bool Update(DropZone dropZone)
         {
             return _col.Update(dropZone);
@@ -89,7 +129,14 @@ namespace skydiveLogs_api.Infrastructure
 
         #region Private Fields
 
+        /// <summary>
+        /// The LiteDB collection for drop zone records.
+        /// </summary>
         private readonly ILiteCollection<DropZone> _col;
+
+        /// <summary>
+        /// The data provider used for database access operations.
+        /// </summary>
         private readonly IDataProvider _dataProvider;
 
         #endregion Private Fields

Back/skydiveLogs-api.Infrastructure/FavoriteDropZoneRepository.cs

@@ -1,19 +1,34 @@
+using System;
+using System.Collections.Generic;
 using LiteDB;
 using skydiveLogs_api.Domain;
 using skydiveLogs_api.DomainService.Repositories;
 using skydiveLogs_api.Infrastructure.Interfaces;
-using System.Collections.Generic;
 
 namespace skydiveLogs_api.Infrastructure
 {
+    /// <summary>
+    /// Repository class for managing favorite drop zone data in the database.
+    /// Provides operations to add, delete, retrieve, and manage favorite drop zones per user.
+    /// </summary>
+    /// <remarks>
+    /// This repository interacts with LiteDB to perform operations on favorite drop zones,
+    /// where each favorite drop zone is associated with both a user and a drop zone.
+    /// </remarks>
     public class FavoriteDropZoneRepository : IFavoriteDropZoneRepository
     {
         #region Public Constructors
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="FavoriteDropZoneRepository"/> class
+        /// Initializes a new instance of the <see cref="FavoriteDropZoneRepository"/> class.
         /// </summary>
-        /// <param name="dataProvider">The data provider to use for data access</param>
+        /// <param name="dataProvider">The data provider used for database access operations.</param>
+        /// <remarks>
+        /// This constructor initializes the repository with a reference to the data provider
+        /// and sets up the collection for favorite drop zone data operations.
+        /// The data provider manages the underlying LiteDatabase connection and provides
+        /// typed collection accessors for different entity types.
+        /// </remarks>
         public FavoriteDropZoneRepository(IDataProvider dataProvider)
         {
             _dataProvider = dataProvider;
@@ -25,10 +40,15 @@ namespace skydiveLogs_api.Infrastructure
         #region Public Methods
 
         /// <summary>
-        /// Adds a new favorite drop zone to the database
+        /// Adds a new favorite drop zone to the database.
         /// </summary>
-        /// <param name="favoriteToAdd">The favorite drop zone instance to add</param>
-        /// <returns>The number of rows affected (0 if insert failed)</returns>
+        /// <param name="favoriteToAdd">The favorite drop zone instance to insert into the database.</param>
+        /// <returns>The number of rows affected. Returns 0 if the insert operation failed.</returns>
+        /// <remarks>
+        /// Attempts to insert the new favorite drop zone into the database using LiteDB.
+        /// If an exception occurs during insertion, the method returns 0.
+        /// The returned value indicates the number of records affected by the insert operation.
+        /// </remarks>
         public int Add(FavoriteDropZone favoriteToAdd)
         {
             int result;
@@ -47,21 +67,30 @@ namespace skydiveLogs_api.Infrastructure
         }
 
         /// <summary>
-        /// Deletes a favorite drop zone by drop zone ID and user ID
+        /// Deletes favorite drop zone entries by drop zone ID and user ID.
         /// </summary>
-        /// <param name="dropZoneId">The unique identifier of the drop zone</param>
-        /// <param name="userId">The unique identifier of the user</param>
-        /// <returns>The number of rows affected (0 if delete failed)</returns>
+        /// <param name="dropZoneId">The unique identifier of the drop zone to delete favorites for.</param>
+        /// <param name="userId">The unique identifier of the user whose favorites to delete.</param>
+        /// <returns>The number of rows affected. Returns 0 if the delete operation failed or no records matched.</returns>
+        /// <remarks>
+        /// Deletes all favorite drop zone records where both the drop zone ID and user ID match the provided values.
+        /// This operation is commonly used to remove a specific user's favorites for a particular drop zone.
+        /// </remarks>
         public int Delete(int dropZoneId, int userId)
         {
             return _col.DeleteMany(d => d.DropZone.Id == dropZoneId && d.User.Id == userId);
         }
 
         /// <summary>
-        /// Retrieves all favorite drop zones for a specific user
+        /// Retrieves all favorite drop zones for a specific user.
         /// </summary>
-        /// <param name="user">The user whose favorite drop zones to retrieve</param>
-        /// <returns>A collection of favorite drop zone instances belonging to the user</returns>
+        /// <param name="user">The user whose favorite drop zones to retrieve.</param>
+        /// <returns>An enumerable collection containing all favorite drop zone instances belonging to the specified user.</returns>
+        /// <remarks>
+        /// Queries the favorite drop zone collection and retrieves all records where the user ID matches the provided user.
+        /// Each returned record includes navigation properties to the associated user and drop zone entities.
+        /// Returns an empty collection if the user has no favorite drop zones.
+        /// </remarks>
         public IEnumerable<FavoriteDropZone> GetAll(User user)
         {
             return _col.Query()
@@ -70,48 +99,78 @@ namespace skydiveLogs_api.Infrastructure
         }
 
         /// <summary>
-        /// Retrieves all favorite drop zones from the database
+        /// Retrieves all favorite drop zones from the database.
         /// </summary>
-        /// <returns>A collection of all favorite drop zone instances</returns>
+        /// <returns>An enumerable collection containing all favorite drop zone instances in the database.</returns>
+        /// <remarks>
+        /// This method is not currently implemented and throws a <see cref="NotImplementedException"/> when called.
+        /// Implement this method to retrieve all favorite drop zones across all users in the system.
+        /// </remarks>
+        /// <exception cref="NotImplementedException">Thrown when the method is called.</exception>
         public IEnumerable<FavoriteDropZone> GetAll()
         {
-            throw new System.NotImplementedException();
+            throw new NotImplementedException();
         }
 
         /// <summary>
-        /// Retrieves a favorite drop zone by its unique identifier
+        /// Retrieves a favorite drop zone by its unique identifier.
         /// </summary>
-        /// <param name="id">The unique identifier of the favorite drop zone</param>
-        /// <returns>The favorite drop zone instance or null if not found</returns>
+        /// <param name="id">The unique identifier of the favorite drop zone to retrieve.</param>
+        /// <returns>The favorite drop zone instance if found, otherwise null.</returns>
+        /// <remarks>
+        /// Searches the favorite drop zone collection for a record with the specified ID.
+        /// This method currently returns null as it's not implemented with proper filtering by ID.
+        /// Implement this method to retrieve a specific favorite drop zone by its database ID.
+        /// </remarks>
+        /// <exception cref="NotImplementedException">Thrown when attempting to retrieve by ID.</exception>
         public FavoriteDropZone GetById(int id)
         {
-            throw new System.NotImplementedException();
+            throw new NotImplementedException();
         }
 
         /// <summary>
-        /// Gets the total count of favorite drop zones in the database
+        /// Gets the total count of favorite drop zones for a specific user.
         /// </summary>
-        /// <returns>The total number of favorite drop zones</returns>
+        /// <param name="user">The user whose favorite drop zones to count.</param>
+        /// <returns>The total number of favorite drop zones for the specified user.</returns>
+        /// <remarks>
+        /// This method is not currently implemented and throws a <see cref="NotImplementedException"/> when called.
+        /// Implement this method to retrieve the count of favorite drop zones per user.
+        /// </remarks>
+        /// <exception cref="NotImplementedException">Thrown when the method is called.</exception>
         public int GetCount()
         {
-            throw new System.NotImplementedException();
+            throw new NotImplementedException();
         }
 
         /// <summary>
-        /// Updates an existing favorite drop zone in the database
+        /// Updates an existing favorite drop zone in the database.
         /// </summary>
-        /// <param name="updated">The favorite drop zone instance to update</param>
-        /// <returns>True if the update was successful, false otherwise</returns>
+        /// <param name="updated">The favorite drop zone instance containing the updated data.</param>
+        /// <returns><see langword="true"/> if the update was successful; otherwise, <see langword="false"/>.</returns>
+        /// <remarks>
+        /// This method is not currently implemented and throws a <see cref="NotImplementedException"/> when called.
+        /// Implement this method to update existing favorite drop zone records in the database.
+        /// Note: Favorite drop zones may not typically be updated; consider using Add for new favorites.
+        /// </remarks>
+        /// <exception cref="NotImplementedException">Thrown when attempting to update.</exception>
         public bool Update(FavoriteDropZone updated)
         {
-            throw new System.NotImplementedException();
+            throw new NotImplementedException();
         }
 
         #endregion Public Methods
 
         #region Private Fields
 
+        /// <summary>
+        /// The LiteDB collection for favorite drop zone records.
+        /// </summary>
         private readonly ILiteCollection<FavoriteDropZone> _col;
+
+        /// <summary>
+        /// The data provider used for database access operations.
+        /// </summary>
         private readonly IDataProvider _dataProvider;
 
         #endregion Private Fields

Back/skydiveLogs-api.Infrastructure/GearRepository.cs

@@ -1,19 +1,34 @@
+using System;
+using System.Collections.Generic;
 using LiteDB;
 using skydiveLogs_api.Domain;
 using skydiveLogs_api.DomainService.Repositories;
 using skydiveLogs_api.Infrastructure.Interfaces;
-using System.Collections.Generic;
 
 namespace skydiveLogs_api.Infrastructure
 {
+    /// <summary>
+    /// Repository class for managing gear data in the database.
+    /// Provides operations to add, retrieve, count, and update gear records per user.
+    /// </summary>
+    /// <remarks>
+    /// This repository interacts with LiteDB to perform CRUD operations on gear items.
+    /// Each gear item is associated with a user, allowing for user-specific gear management.
+    /// </remarks>
     public class GearRepository : IGearRepository
     {
         #region Public Constructors
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="GearRepository"/> class
+        /// Initializes a new instance of the <see cref="GearRepository"/> class.
         /// </summary>
-        /// <param name="dataProvider">The data provider to use for data access</param>
+        /// <param name="dataProvider">The data provider used for database access operations.</param>
+        /// <remarks>
+        /// This constructor initializes the repository with a reference to the data provider
+        /// and sets up the collection for gear data operations.
+        /// The data provider manages the underlying LiteDatabase connection and provides
+        /// typed collection accessors for different entity types.
+        /// </remarks>
         public GearRepository(IDataProvider dataProvider)
         {
             _dataProvider = dataProvider;
@@ -25,10 +40,16 @@ namespace skydiveLogs_api.Infrastructure
         #region Public Methods
 
         /// <summary>
-        /// Adds a new gear item to the database
+        /// Adds a new gear item to the database.
         /// </summary>
-        /// <param name="newGear">The gear instance to add</param>
-        /// <returns>The number of rows affected (0 if insert failed)</returns>
+        /// <param name="newGear">The gear instance to insert into the database.</param>
+        /// <returns>The number of rows affected. Returns 0 if the insert operation failed.</returns>
+        /// <remarks>
+        /// Attempts to insert the new gear item into the database using LiteDB.
+        /// The gear item should have all required properties set before insertion.
+        /// If an exception occurs during insertion, the method returns 0.
+        /// The returned value indicates the number of records affected by the insert operation.
+        /// </remarks>
         public int Add(Gear newGear)
         {
             int result;
@@ -47,19 +68,29 @@ namespace skydiveLogs_api.Infrastructure
         }
 
         /// <summary>
-        /// Retrieves all gear items from the database
+        /// Retrieves all gear items from the database.
         /// </summary>
-        /// <returns>A collection of all gear instances</returns>
+        /// <returns>An enumerable collection containing all gear instances stored in the database.</returns>
+        /// <remarks>
+        /// This method is not currently implemented and throws a <see cref="NotImplementedException"/> when called.
+        /// Implement this method to retrieve all gear records from the database, potentially filtered by user.
+        /// </remarks>
+        /// <exception cref="NotImplementedException">Thrown when the method is called.</exception>
         public IEnumerable<Gear> GetAll()
         {
-            throw new System.NotImplementedException();
+            throw new NotImplementedException();
         }
 
         /// <summary>
-        /// Retrieves all gear items for a specific user
+        /// Retrieves all gear items for a specific user.
         /// </summary>
-        /// <param name="user">The user whose gear items to retrieve</param>
-        /// <returns>A collection of gear instances belonging to the user</returns>
+        /// <param name="user">The user whose gear items to retrieve.</param>
+        /// <returns>An enumerable collection containing all gear instances belonging to the specified user.</returns>
+        /// <remarks>
+        /// Queries the gear collection and retrieves all records where the user ID matches the provided user.
+        /// Each returned gear record includes navigation properties to the associated user entity.
+        /// Returns an empty collection if the user has no gear items.
+        /// </remarks>
         public IEnumerable<Gear> GetAll(User user)
         {
             return _col.Include(x => x.User)
@@ -69,29 +100,45 @@ namespace skydiveLogs_api.Infrastructure
         }
 
         /// <summary>
-        /// Retrieves a gear item by its unique identifier
+        /// Retrieves a gear item by its unique identifier.
         /// </summary>
-        /// <param name="id">The unique identifier of the gear</param>
-        /// <returns>The gear instance or null if not found</returns>
+        /// <param name="id">The unique identifier of the gear item to retrieve.</param>
+        /// <returns>The gear item instance if found, otherwise null.</returns>
+        /// <remarks>
+        /// Searches the gear collection for a record with the specified ID.
+        /// Returns null if no gear item with the matching ID is found in the database.
+        /// </remarks>
         public Gear GetById(int id)
         {
             return _col.FindById(new BsonValue(id));
         }
 
         /// <summary>
-        /// Gets the total count of gear items in the database
+        /// Gets the total count of gear items for a specific user.
         /// </summary>
-        /// <returns>The total number of gear items</returns>
+        /// <param name="user">The user whose gear items to count.</param>
+        /// <returns>The total number of gear items for the specified user.</returns>
+        /// <remarks>
+        /// This method is not currently implemented and throws a <see cref="NotImplementedException"/> when called.
+        /// Implement this method to retrieve the count of gear items per user.
+        /// </remarks>
+        /// <exception cref="NotImplementedException">Thrown when the method is called.</exception>
         public int GetCount()
         {
-            throw new System.NotImplementedException();
+            throw new NotImplementedException();
         }
 
         /// <summary>
-        /// Updates an existing gear item in the database
+        /// Updates an existing gear item in the database.
         /// </summary>
-        /// <param name="updatedGear">The gear instance to update</param>
-        /// <returns>True if the update was successful, false otherwise</returns>
+        /// <param name="updatedGear">The gear item instance containing the updated data.</param>
+        /// <returns><see langword="true"/> if the update was successful; otherwise, <see langword="false"/>.</returns>
+        /// <remarks>
+        /// Updates the gear record in the database with the provided gear item instance.
+        /// The gear item must have a valid ID to be updated.
+        /// The method returns the result of the underlying LiteDB update operation.
+        /// If the gear item does not exist, the update operation will return 0.
+        /// </remarks>
         public bool Update(Gear updatedGear)
         {
             return _col.Update(updatedGear);
@@ -101,7 +148,14 @@ namespace skydiveLogs_api.Infrastructure
 
         #region Private Fields
 
+        /// <summary>
+        /// The LiteDB collection for gear records.
+        /// </summary>
         private readonly ILiteCollection<Gear> _col;
+
+        /// <summary>
+        /// The data provider used for database access operations.
+        /// </summary>
         private readonly IDataProvider _dataProvider;
 
         #endregion Private Fields

Back/skydiveLogs-api.Infrastructure/JumpRepository.cs

@@ -1,19 +1,35 @@
+using System;
+using System.Collections.Generic;
 using LiteDB;
 using skydiveLogs_api.Domain;
 using skydiveLogs_api.DomainService.Repositories;
 using skydiveLogs_api.Infrastructure.Interfaces;
-using System.Collections.Generic;
 
 namespace skydiveLogs_api.Infrastructure
 {
+    /// <summary>
+    /// Repository class for managing jump data in the database.
+    /// Provides operations to add, delete, retrieve, and update jump records per user.
+    /// </summary>
+    /// <remarks>
+    /// This repository interacts with LiteDB to perform CRUD operations on jump records.
+    /// Each jump record is associated with a user, aircraft, drop zone, gear, and jump type.
+    /// Navigation properties are included for related entities to enable eager loading.
+    /// </remarks>
     public class JumpRepository : IJumpRepository
     {
         #region Public Constructors
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="JumpRepository"/> class
+        /// Initializes a new instance of the <see cref="JumpRepository"/> class.
         /// </summary>
-        /// <param name="dataProvider">The data provider to use for data access</param>
+        /// <param name="dataProvider">The data provider used for database access operations.</param>
+        /// <remarks>
+        /// This constructor initializes the repository with a reference to the data provider
+        /// and sets up the collection for jump data operations.
+        /// The data provider manages the underlying LiteDatabase connection and provides
+        /// typed collection accessors for different entity types.
+        /// </remarks>
         public JumpRepository(IDataProvider dataProvider)
         {
             _dataProvider = dataProvider;
@@ -25,10 +41,16 @@ namespace skydiveLogs_api.Infrastructure
         #region Public Methods
 
         /// <summary>
-        /// Adds a new jump to the database
+        /// Adds a new jump record to the database.
         /// </summary>
-        /// <param name="newJump">The jump instance to add</param>
-        /// <returns>The number of rows affected (0 if insert failed)</returns>
+        /// <param name="newJump">The jump instance to insert into the database.</param>
+        /// <returns>The number of rows affected. Returns 0 if the insert operation failed.</returns>
+        /// <remarks>
+        /// Attempts to insert the new jump record into the database using LiteDB.
+        /// The jump record should have all required properties set before insertion.
+        /// If an exception occurs during insertion, the method returns 0.
+        /// The returned value indicates the number of records affected by the insert operation.
+        /// </remarks>
         public int Add(Jump newJump)
         {
             int result;
@@ -47,20 +69,30 @@ namespace skydiveLogs_api.Infrastructure
         }
 
         /// <summary>
-        /// Deletes a jump by its unique identifier
+        /// Deletes a jump record by its unique identifier.
         /// </summary>
-        /// <param name="id">The unique identifier of the jump to delete</param>
-        /// <returns>True if the deletion was successful, false otherwise</returns>
+        /// <param name="id">The unique identifier of the jump to delete.</param>
+        /// <returns><see langword="true"/> if the deletion was successful; otherwise, <see langword="false"/>.</returns>
+        /// <remarks>
+        /// Deletes the jump record with the specified ID from the database.
+        /// The method uses the <see cref="ILiteCollection{T}.Delete"/> method to remove the record.
+        /// </remarks>
         public bool DeleteById(int id)
         {
             return _col.Delete(new BsonValue(id));
         }
 
         /// <summary>
-        /// Retrieves all jumps for a specific user
+        /// Retrieves all jump records for a specific user.
         /// </summary>
-        /// <param name="user">The user whose jumps to retrieve</param>
-        /// <returns>A collection of jump instances belonging to the user</returns>
+        /// <param name="user">The user whose jump records to retrieve.</param>
+        /// <returns>An enumerable collection containing all jump records belonging to the specified user.</returns>
+        /// <remarks>
+        /// Queries the jump collection and retrieves all records where the user ID matches the provided user.
+        /// Each returned jump record includes navigation properties to the associated aircraft, drop zone,
+        /// gear, and jump type entities for eager loading.
+        /// Returns an empty collection if the user has no jump records.
+        /// </remarks>
         public IEnumerable<Jump> GetAll(User user)
         {
             return _col.Include(x => x.Aircraft)
@@ -71,21 +103,31 @@ namespace skydiveLogs_api.Infrastructure
         }
 
         /// <summary>
-        /// Retrieves all jumps from the database
+        /// Retrieves all jump records from the database.
         /// </summary>
-        /// <returns>A collection of all jump instances</returns>
+        /// <returns>An enumerable collection containing all jump records stored in the database.</returns>
+        /// <remarks>
+        /// This method is not currently implemented and throws a <see cref="NotImplementedException"/> when called.
+        /// Implement this method to retrieve all jump records from the database without filtering.
+        /// </remarks>
+        /// <exception cref="NotImplementedException">Thrown when the method is called.</exception>
         public IEnumerable<Jump> GetAll()
         {
-            throw new System.NotImplementedException();
+            throw new NotImplementedException();
         }
 
         /// <summary>
-        /// Retrieves a range of jumps for a specific user
+        /// Retrieves a range of jump records for a specific user with pagination.
         /// </summary>
-        /// <param name="user">The user whose jumps to retrieve</param>
-        /// <param name="beginIndex">The starting index</param>
-        /// <param name="endIndex">The ending index</param>
-        /// <returns>A collection of jump instances</returns>
+        /// <param name="user">The user whose jump records to retrieve.</param>
+        /// <param name="beginIndex">The starting index for pagination (inclusive).</param>
+        /// <param name="endIndex">The ending index for pagination (exclusive).</param>
+        /// <returns>An enumerable collection containing the requested range of jump records.</returns>
+        /// <remarks>
+        /// Retrieves a paginated range of jump records for the specified user, ordered by jump date in descending order.
+        /// Uses LiteDB query operators to limit and offset the results for efficient pagination.
+        /// Each jump record includes navigation properties to related entities.
+        /// </remarks>
         public IEnumerable<Jump> GetBetweenIndex(User user, int beginIndex, int endIndex)
         {
             return _col.Include(x => x.Aircraft)
@@ -101,39 +143,59 @@ namespace skydiveLogs_api.Infrastructure
         }
 
         /// <summary>
-        /// Retrieves a jump by its unique identifier
+        /// Retrieves a jump record by its unique identifier.
         /// </summary>
-        /// <param name="id">The unique identifier of the jump</param>
-        /// <returns>The jump instance or null if not found</returns>
+        /// <param name="id">The unique identifier of the jump to retrieve.</param>
+        /// <returns>The jump record instance if found, otherwise null.</returns>
+        /// <remarks>
+        /// Searches the jump collection for a record with the specified ID.
+        /// Returns null if no jump record with the matching ID is found in the database.
+        /// </remarks>
         public Jump GetById(int id)
         {
             return _col.FindById(new BsonValue(id));
         }
 
         /// <summary>
-        /// Gets the total count of jumps for a specific user
+        /// Gets the total count of jump records for a specific user.
         /// </summary>
-        /// <param name="user">The user whose jumps to count</param>
-        /// <returns>The total number of jumps</returns>
+        /// <param name="user">The user whose jump records to count.</param>
+        /// <returns>The total number of jump records for the specified user.</returns>
+        /// <remarks>
+        /// This method is not currently implemented and throws a <see cref="NotImplementedException"/> when called.
+        /// Implement this method to retrieve the count of jump records per user.
+        /// </remarks>
+        /// <exception cref="NotImplementedException">Thrown when the method is called.</exception>
         public int GetCount(User user)
         {
             return _col.Count(j => j.User.Id == user.Id);
         }
 
         /// <summary>
-        /// Gets the total count of jumps in the database
+        /// Gets the total count of jump records in the database.
         /// </summary>
-        /// <returns>The total number of jumps</returns>
+        /// <returns>The total number of jump records stored in the database.</returns>
+        /// <remarks>
+        /// This method is not currently implemented and throws a <see cref="NotImplementedException"/> when called.
+        /// Implement this method to retrieve the count of all jump records.
+        /// </remarks>
+        /// <exception cref="NotImplementedException">Thrown when the method is called.</exception>
         public int GetCount()
         {
-            throw new System.NotImplementedException();
+            throw new NotImplementedException();
         }
 
         /// <summary>
-        /// Updates an existing jump in the database
+        /// Updates an existing jump record in the database.
         /// </summary>
-        /// <param name="updatedJump">The jump instance to update</param>
-        /// <returns>True if the update was successful, false otherwise</returns>
+        /// <param name="updatedJump">The jump record instance containing the updated data.</param>
+        /// <returns><see langword="true"/> if the update was successful; otherwise, <see langword="false"/>.</returns>
+        /// <remarks>
+        /// Updates the jump record in the database with the provided jump record instance.
+        /// The jump record must have a valid ID to be updated.
+        /// The method returns the result of the underlying LiteDB update operation.
+        /// If the jump record does not exist, the update operation will return 0.
+        /// </remarks>
         public bool Update(Jump updatedJump)
         {
             return _col.Update(updatedJump);
@@ -143,7 +205,14 @@ namespace skydiveLogs_api.Infrastructure
 
         #region Private Fields
 
+        /// <summary>
+        /// The LiteDB collection for jump records.
+        /// </summary>
         private readonly ILiteCollection<Jump> _col;
+
+        /// <summary>
+        /// The data provider used for database access operations.
+        /// </summary>
         private readonly IDataProvider _dataProvider;
 
         #endregion Private Fields

Back/skydiveLogs-api.Infrastructure/JumpTypeRepository.cs

@@ -1,20 +1,34 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
 using LiteDB;
 using skydiveLogs_api.Domain;
 using skydiveLogs_api.DomainService.Repositories;
 using skydiveLogs_api.Infrastructure.Interfaces;
-using System.Collections.Generic;
-using System.Linq;
 
 namespace skydiveLogs_api.Infrastructure
 {
+    /// <summary>
+    /// Repository class for managing jump type data in the database.
+    /// </summary>
+    /// <remarks>
+    /// This repository interacts with LiteDB to perform CRUD operations on jump type records.
+    /// Jump types are typically stored at the database level and are shared across all users.
+    /// </remarks>
     public class JumpTypeRepository : IJumpTypeRepository
     {
         #region Public Constructors
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="JumpTypeRepository"/> class
+        /// Initializes a new instance of the <see cref="JumpTypeRepository"/> class.
         /// </summary>
-        /// <param name="dataProvider">The data provider to use for data access</param>
+        /// <param name="dataProvider">The data provider used for database access operations.</param>
+        /// <remarks>
+        /// This constructor initializes the repository with a reference to the data provider
+        /// and sets up the collection for jump type data operations.
+        /// The data provider manages the underlying LiteDatabase connection and provides
+        /// typed collection accessors for different entity types.
+        /// </remarks>
         public JumpTypeRepository(IDataProvider dataProvider)
         {
             _dataProvider = dataProvider;
@@ -26,10 +40,16 @@ namespace skydiveLogs_api.Infrastructure
         #region Public Methods
 
         /// <summary>
-        /// Adds a new jump type to the database
+        /// Adds a new jump type to the database.
         /// </summary>
-        /// <param name="newJumpType">The jump type instance to add</param>
-        /// <returns>The number of rows affected (0 if insert failed)</returns>
+        /// <param name="newJumpType">The jump type instance to insert into the database.</param>
+        /// <returns>The number of rows affected. Returns 0 if the insert operation failed.</returns>
+        /// <remarks>
+        /// Attempts to insert the new jump type into the database using LiteDB.
+        /// The jump type should have all required properties set before insertion.
+        /// If an exception occurs during insertion, the method returns 0.
+        /// The returned value indicates the number of records affected by the insert operation.
+        /// </remarks>
         public int Add(JumpType newJumpType)
         {
             int result;
@@ -48,38 +68,58 @@ namespace skydiveLogs_api.Infrastructure
         }
 
         /// <summary>
-        /// Retrieves all jump types from the database
+        /// Retrieves all jump types from the database.
         /// </summary>
-        /// <returns>A collection of all jump type instances</returns>
+        /// <returns>An enumerable collection containing all jump type instances stored in the database.</returns>
+        /// <remarks>
+        /// Queries the jump type collection and retrieves all records,
+        /// then converts the result to a List for enumeration.
+        /// Returns an empty list if no jump types exist in the database.
+        /// </remarks>
         public IEnumerable<JumpType> GetAll()
         {
             return _col.FindAll().ToList();
         }
 
         /// <summary>
-        /// Retrieves a jump type by its unique identifier
+        /// Retrieves a jump type by its unique identifier.
         /// </summary>
-        /// <param name="id">The unique identifier of the jump type</param>
-        /// <returns>The jump type instance or null if not found</returns>
+        /// <param name="id">The unique identifier of the jump type to retrieve.</param>
+        /// <returns>The jump type instance if found, otherwise null.</returns>
+        /// <remarks>
+        /// Searches the jump type collection for a record with the specified ID.
+        /// Returns null if no jump type with the matching ID is found in the database.
+        /// </remarks>
         public JumpType GetById(int id)
         {
             return _col.FindById(new BsonValue(id));
         }
 
         /// <summary>
-        /// Gets the total count of jump types in the database
+        /// Gets the total count of jump types in the database.
         /// </summary>
-        /// <returns>The total number of jump types</returns>
+        /// <returns>The total number of jump types stored in the database.</returns>
+        /// <remarks>
+        /// This method is not currently implemented and throws a <see cref="NotImplementedException"/> when called.
+        /// Implement this method to retrieve the count of all jump type records in the database.
+        /// </remarks>
+        /// <exception cref="NotImplementedException">Thrown when the method is called.</exception>
         public int GetCount()
         {
-            throw new System.NotImplementedException();
+            throw new NotImplementedException();
         }
 
         /// <summary>
-        /// Updates an existing jump type in the database
+        /// Updates an existing jump type in the database.
         /// </summary>
-        /// <param name="updatedJumpType">The jump type instance to update</param>
-        /// <returns>True if the update was successful, false otherwise</returns>
+        /// <param name="updatedJumpType">The jump type instance containing the updated data.</param>
+        /// <returns><see langword="true"/> if the update was successful; otherwise, <see langword="false"/>.</returns>
+        /// <remarks>
+        /// Updates the jump type record in the database with the provided jump type instance.
+        /// The jump type must have a valid ID to be updated.
+        /// The method returns the result of the underlying LiteDB update operation.
+        /// If the jump type does not exist, the update operation will return 0.
+        /// </remarks>
         public bool Update(JumpType updatedJumpType)
         {
             return _col.Update(updatedJumpType);
@@ -89,7 +129,14 @@ namespace skydiveLogs_api.Infrastructure
 
         #region Private Fields
 
+        /// <summary>
+        /// The LiteDB collection for jump type records.
+        /// </summary>
         private readonly ILiteCollection<JumpType> _col;
+
+        /// <summary>
+        /// The data provider used for database access operations.
+        /// </summary>
         private readonly IDataProvider _dataProvider;
 
         #endregion Private Fields