doc

Author: YunchuWang

src/Extensions/Azure/DurableTaskSchedulerExtensions.cs

@@ -8,9 +8,19 @@
 
 namespace Microsoft.DurableTask.Extensions.Azure;
 
+/// <summary>
+/// Extension methods for configuring Durable Task workers and clients to use the Azure Durable Task Scheduler service.
+/// </summary>
 public static class DurableTaskSchedulerExtensions
 {
-    // Configure the Durable Task *Worker* to use the Durable Task Scheduler service with the specified options.
+    /// <summary>
+    /// Configures Durable Task worker to use the Azure Durable Task Scheduler service.
+    /// </summary>
+    /// <param name="builder">The worker builder to configure.</param>
+    /// <param name="endpointAddress">The endpoint address of the Durable Task Scheduler service.</param>
+    /// <param name="taskHubName">The name of the task hub to connect to.</param>
+    /// <param name="credential">The credential to use for authentication.</param>
+    /// <param name="configure">Optional callback to configure additional options.</param>
     public static void UseDurableTaskScheduler(
         this IDurableTaskWorkerBuilder builder,
         string endpointAddress,
@@ -19,10 +29,18 @@ public static void UseDurableTaskScheduler(
         Action<DurableTaskSchedulerOptions>? configure = null)
     {
         DurableTaskSchedulerOptions options = new(endpointAddress, taskHubName, credential);
+
         configure?.Invoke(options);
+
         builder.UseGrpc(GetGrpcChannelForOptions(options));
     }
 
+    /// <summary>
+    /// Configures Durable Task worker to use the Azure Durable Task Scheduler service using a connection string.
+    /// </summary>
+    /// <param name="builder">The worker builder to configure.</param>
+    /// <param name="connectionString">The connection string for the Durable Task Scheduler service.</param>
+    /// <param name="configure">Optional callback to configure additional options.</param>
     public static void UseDurableTaskScheduler(
         this IDurableTaskWorkerBuilder builder,
         string connectionString,
@@ -33,7 +51,14 @@ public static void UseDurableTaskScheduler(
         builder.UseGrpc(GetGrpcChannelForOptions(options));
     }
 
-    // Configure the Durable Task *Client* to use the Durable Task Scheduler service with the specified options.
+    /// <summary>
+    /// Configures Durable Task client to use the Azure Durable Task Scheduler service.
+    /// </summary>
+    /// <param name="builder">The client builder to configure.</param>
+    /// <param name="endpointAddress">The endpoint address of the Durable Task Scheduler service.</param>
+    /// <param name="taskHubName">The name of the task hub to connect to.</param>
+    /// <param name="credential">The credential to use for authentication.</param>
+    /// <param name="configure">Optional callback to configure additional options.</param>
     public static void UseDurableTaskScheduler(
         this IDurableTaskClientBuilder builder,
         string endpointAddress,
@@ -42,10 +67,18 @@ public static void UseDurableTaskScheduler(
         Action<DurableTaskSchedulerOptions>? configure = null)
     {
         DurableTaskSchedulerOptions options = new(endpointAddress, taskHubName, credential);
+
         configure?.Invoke(options);
+
         builder.UseGrpc(GetGrpcChannelForOptions(options));
     }
 
+    /// <summary>
+    /// Configures Durable Task client to use the Azure Durable Task Scheduler service using a connection string.
+    /// </summary>
+    /// <param name="builder">The client builder to configure.</param>
+    /// <param name="connectionString">The connection string for the Durable Task Scheduler service.</param>
+    /// <param name="configure">Optional callback to configure additional options.</param>
     public static void UseDurableTaskScheduler(
         this IDurableTaskClientBuilder builder,
         string connectionString,

src/Extensions/Azure/DurableTaskSchedulerOptions.cs

@@ -8,8 +8,6 @@
 
 namespace Microsoft.DurableTask.Extensions.Azure;
 
-// NOTE: These options definitions will eventually be provided by the Durable Task SDK itself.
-
 /// <summary>
 /// Options for configuring the Durable Task Scheduler.
 /// </summary>
@@ -50,12 +48,23 @@ internal DurableTaskSchedulerOptions(string endpointAddress, string taskHubName,
     /// </summary>
     public string? WorkerId { get; set; }
 
-
+    /// <summary>
+    /// Creates a new instance of <see cref="DurableTaskSchedulerOptions"/> from a connection string.
+    /// </summary>
+    /// <param name="connectionString">The connection string containing the configuration settings.</param>
+    /// <returns>A new instance of <see cref="DurableTaskSchedulerOptions"/> configured with the connection string settings.</returns>
+    /// <exception cref="ArgumentException">Thrown when the connection string contains an unsupported authentication type.</exception>
     public static DurableTaskSchedulerOptions FromConnectionString(string connectionString)
     {
         return FromConnectionString(new DurableTaskSchedulerConnectionString(connectionString));
     }
 
+    /// <summary>
+    /// Creates a new instance of <see cref="DurableTaskSchedulerOptions"/> from a parsed connection string.
+    /// </summary>
+    /// <param name="connectionString">The parsed connection string containing the configuration settings.</param>
+    /// <returns>A new instance of <see cref="DurableTaskSchedulerOptions"/> configured with the connection string settings.</returns>
+    /// <exception cref="ArgumentException">Thrown when the connection string contains an unsupported authentication type.</exception>
     public static DurableTaskSchedulerOptions FromConnectionString(
         DurableTaskSchedulerConnectionString connectionString)
     {