XML comment improvements

src/Tingle.Extensions.PushNotifications/Apple/ApnsNotifier.cs

@@ -24,7 +24,7 @@ public ApnsNotifier(HttpClient httpClient, IOptionsSnapshot<ApnsNotifierOptions>
     /// <summary>Send a push notification via Apple Push Notification Service (APNS).</summary>
     /// <param name="header">The header for the notification</param>
     /// <param name="data">The data</param>
-    /// <param name="cancellationToken"></param>
+    /// <param name="cancellationToken">The token to cancel the request.</param>
     public virtual Task<ResourceResponse<ApnsMessageResponse, ApnsResponseError>> SendAsync(ApnsMessageHeader header,
                                                                                             ApnsMessageData data,
                                                                                             CancellationToken cancellationToken = default)
@@ -34,7 +34,7 @@ public virtual Task<ResourceResponse<ApnsMessageResponse, ApnsResponseError>> Se
     /// <param name="header">The header for the notification</param>
     /// <param name="data">The data</param>
     /// <param name="jsonTypeInfo">Metadata about the <typeparamref name="TData"/> to convert.</param>
-    /// <param name="cancellationToken"></param>
+    /// <param name="cancellationToken">The token to cancel the request.</param>
     public virtual async Task<ResourceResponse<ApnsMessageResponse, ApnsResponseError>> SendAsync<TData>(ApnsMessageHeader header,
                                                                                                          TData data,
                                                                                                          JsonTypeInfo<TData> jsonTypeInfo,

src/Tingle.Extensions.PushNotifications/Firebase/Models/FirebaseRequest.cs

@@ -2,14 +2,10 @@
 
 namespace Tingle.Extensions.PushNotifications.Firebase.Models;
 
-/// <summary>
-/// Represents a request payload sent to Firebase Cloud Messaging (FCM)
-/// </summary>
+/// <summary>Represents a request payload sent to Firebase Cloud Messaging (FCM).</summary>
 public class FirebaseRequest
 {
-    /// <summary>
-    /// 
-    /// </summary>
+    /// <summary>Creates an instance of <see cref="FirebaseRequest"/>.</summary>
     /// <param name="message">Message to send.</param>
     /// <param name="validateOnly">Flag for testing the request without actually delivering the message.</param>
     public FirebaseRequest(FirebaseRequestMessage message, bool? validateOnly = null)
@@ -18,15 +14,11 @@ public FirebaseRequest(FirebaseRequestMessage message, bool? validateOnly = null
         ValidateOnly = validateOnly;
     }
 
-    /// <summary>
-    /// Message to send.
-    /// </summary>
+    /// <summary>Message to send.</summary>
     [JsonPropertyName("message")]
     public FirebaseRequestMessage Message { get; set; }
 
-    /// <summary>
-    /// Flag for testing the request without actually delivering the message.
-    /// </summary>
+    /// <summary>Flag for testing the request without actually delivering the message.</summary>
     [JsonPropertyName("validate_only")]
     public bool? ValidateOnly { get; set; }
 }

src/Tingle.Extensions.PushNotifications/ResourceResponseExtensions.cs

@@ -5,9 +5,9 @@ namespace Tingle.Extensions.PushNotifications;
 /// <summary>Extensions for <see cref="ResourceResponse{TResource, TProblem}"/>.</summary>
 public static class ResourceResponseExtensions
 {
-    /// <summary>Get the request id from the response headers.</summary>
-    /// <param name="headers"></param>
-    /// <returns></returns>
+    /// <summary>Get the APNs request Id.</summary>
+    /// <param name="headers">The <see cref="ResourceResponseHeaders"/> instance.</param>
+    /// <returns>Value for the <c>apns-id</c> header.</returns>
     public static string? GetApnsId(this ResourceResponseHeaders headers)
     {
         if (headers is null) throw new ArgumentNullException(nameof(headers));