Documentation modifications

adas-core.Domain/Models/Responses/DisplayConfigMinimalResponse.cs

@@ -12,10 +12,20 @@ namespace adas_core.Domain.Models.Responses;
 /// </remarks>
 public class DisplayConfigMinimalResponse
 {
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DisplayConfigMinimalResponse"/> class, which represents a minimal response payload carrying display configuration data.
+    /// </summary>
+    /// <!-- aidoc:v1 sig=722895f body=4448e1d -->
     public DisplayConfigMinimalResponse()
     {
     }
 
+    /// <summary>
+    /// Initializes a new <see cref="DisplayConfigMinimalResponse"/>, a minimal response view of a display configuration, from the supplied <paramref name="displayConfig"/> and optional <paramref name="isInUse"/> flag.
+    /// </summary>
+    /// <param name="displayConfig">The source <see cref="DisplayConfigSummary"/> whose <see cref="DisplayConfigSummary.Id"/>, <see cref="DisplayConfigSummary.Type"/>, and <see cref="DisplayConfigSummary.Name"/> populate the response.</param>
+    /// <param name="isInUse">The nullable boolean indicating whether the display configuration is in use, stored in <see cref="DisplayConfigMinimalResponse.IsInUse"/>.</param>
+    /// <!-- aidoc:v1 sig=017b17e body=422f274 -->
     public DisplayConfigMinimalResponse(DisplayConfigSummary displayConfig, bool? isInUse = false)
     {
         Id = displayConfig.Id;

adas-core.Domain/Models/Responses/PaginationResponse.cs

@@ -6,6 +6,14 @@
 /// <typeparam name="T">The type of the items contained in the paginated response.</typeparam>
 public class PaginationResponse<T>
 {
+    /// <summary>
+    /// Initializes a new instance of <see cref="PaginationResponse{T}"/> with the supplied page items and pagination metadata, deriving the total page count from <paramref name="totalRecords"/> and <paramref name="pageSize"/>.
+    /// </summary>
+    /// <param name="data">The <see cref="List{T}"/> of items included in the current page.</param>
+    /// <param name="pageNumber">The number of the current page.</param>
+    /// <param name="pageSize">The maximum number of items per page.</param>
+    /// <param name="totalRecords">The total number of records available across all pages.</param>
+    /// <!-- aidoc:v1 sig=bbc53e5 body=c9e44a7 -->
     public PaginationResponse(List<T> data, int pageNumber, int pageSize, long totalRecords)
     {
         PageNumber = pageNumber;

adas-core.Domain/Models/Responses/PatientSearch.cs

@@ -2,6 +2,10 @@ using adas_core.Domain.Models.MongoModels;
 
 namespace adas_core.Domain.Models.Responses;
 
+/// <summary>
+/// Encapsulates the outcome of a <see cref="Patient"/> lookup, bundling the matched <see cref="Patient"/>, the corresponding archived <see cref="Patient"/>, the related <see cref="Admission"/>, and flags that indicate archive status and result availability.
+/// </summary>
+/// <!-- aidoc:v1 sig=461ed22 -->
 public class PatientSearch(
     Patient? patient,
     Patient? archivePatient,

adas-core.Domain/Models/Responses/Response.cs

@@ -6,10 +6,19 @@
 /// <typeparam name="T">The type of the payload contained within the response.</typeparam>
 public class Response<T>
 {
+    /// <summary>
+    /// Initializes a new instance of the <see cref="Response"/> class using default values.
+    /// </summary>
+    /// <!-- aidoc:v1 sig=c192431 body=4448e1d -->
     public Response()
     {
     }
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="Response{T}"/> class representing a successful result, setting <see cref="Response{T}.Succeeded"/> to <c>true</c>, <see cref="Response{T}.Message"/> to an empty string, <see cref="Response{T}.Errors"/> to <c>null</c>, and storing the supplied payload in <see cref="Response{T}.Data"/>.
+    /// </summary>
+    /// <param name="data">The payload to expose through <see cref="Response{T}.Data"/>.</param>
+    /// <!-- aidoc:v1 sig=f4d0833 body=8db513f -->
     public Response(T data)
     {
         Succeeded = true;