Documentation modifications

adas-core.Infrastructure/Repositories/UnitRepository.cs

@@ -28,6 +28,12 @@ public class UnitRepository : MongoRepository<Unit>, IUnitRepository
 
     
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="UnitRepository"/> class by forwarding the <see cref="IMongoDatabase"/> to the base constructor and storing the <see cref="ApiSettings"/> obtained from <paramref name="apiSettings"/>.
+    /// </summary>
+    /// <param name="apiSettings">The <see cref="IOptions{ApiSettings}"/> wrapper whose <see cref="IOptions{T}.Value"/> provides the <see cref="ApiSettings"/> configuration used by the repository.</param>
+    /// <param name="database">The <see cref="IMongoDatabase"/> connection passed to the base class constructor.</param>
+    /// <!-- aidoc:v1 sig=303625e body=12fddac -->
     public UnitRepository(IOptions<ApiSettings> apiSettings, IMongoDatabase database) : base(database)
     {
         _apiSettings = apiSettings.Value;
@@ -105,6 +111,13 @@ public class UnitRepository : MongoRepository<Unit>, IUnitRepository
             throw new NotImplementedException();
         }
 
+    /// <summary>
+    /// Finds all <see cref="Unit"/> records linked to the supplied master list identifier, dynamically resolving the property to filter on based on <paramref name="masterListType"/>. Any failure encountered while querying is logged and rethrown.
+    /// </summary>
+    /// <param name="id">The <see cref="ObjectId"/> of the master list whose related units should be retrieved.</param>
+    /// <param name="masterListType">The <see cref="MasterListType"/> that selects which property of <see cref="Unit"/> is matched against <paramref name="id"/>.</param>
+    /// <returns>A task yielding an <see cref="IEnumerable{Unit}"/> with the units that satisfy the resolved filter.</returns>
+    /// <!-- aidoc:v1 sig=ec8caf6 body=2a1b3b7 -->
     public async Task<IEnumerable<Unit>> FindByMasterListId(ObjectId id, MasterListType masterListType)
     {
         try