From 56beb5212403a81178906c8b5341e81940244498 Mon Sep 17 00:00:00 2001 From: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com> Date: Thu, 2 Oct 2025 14:58:11 +0100 Subject: [PATCH] .NET: Fix lists in XML comments so they render properly in the documentation. (#1113) * fix lists in XML comments so they render properly in documentation. * Update dotnet/src/Microsoft.Agents.AI.A2A/A2AHostAgent.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update dotnet/src/Microsoft.Agents.AI.A2A/A2AHostAgent.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update dotnet/src/Microsoft.Agents.AI.A2A/A2AHostAgent.cs Co-authored-by: Stephen Toub * Update dotnet/src/Microsoft.Agents.AI.A2A/A2AHostAgent.cs Co-authored-by: Stephen Toub * Update dotnet/src/Microsoft.Agents.AI.A2A/A2AHostAgent.cs Co-authored-by: Stephen Toub * Update dotnet/src/Microsoft.Agents.AI.A2A/Extensions/A2ACardResolverExtensions.cs Co-authored-by: Stephen Toub * Update dotnet/src/Microsoft.Agents.AI.A2A/A2AHostAgent.cs Co-authored-by: Stephen Toub * Update dotnet/src/Microsoft.Agents.AI.A2A/A2AHostAgent.cs Co-authored-by: Stephen Toub * Update dotnet/src/Microsoft.Agents.AI.A2A/A2AHostAgent.cs Co-authored-by: Stephen Toub --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Stephen Toub --- .../Microsoft.Agents.AI.A2A/A2AHostAgent.cs | 25 +++++++++++-------- .../Extensions/A2ACardResolverExtensions.cs | 6 ++--- .../AgentAbstractionsJsonUtilities.cs | 10 ++++---- .../ChatClient/ChatClientAgentThread.cs | 8 +++--- 4 files changed, 26 insertions(+), 23 deletions(-) diff --git a/dotnet/src/Microsoft.Agents.AI.A2A/A2AHostAgent.cs b/dotnet/src/Microsoft.Agents.AI.A2A/A2AHostAgent.cs index 446d0f65e0..725c80b871 100644 --- a/dotnet/src/Microsoft.Agents.AI.A2A/A2AHostAgent.cs +++ b/dotnet/src/Microsoft.Agents.AI.A2A/A2AHostAgent.cs @@ -14,16 +14,19 @@ namespace Microsoft.Agents.AI.A2A; /// /// This implementation only handles: /// -/// TaskManager.OnMessageReceived -/// TaskManager.OnAgentCardQuery +/// TaskManager.OnMessageReceived +/// TaskManager.OnAgentCardQuery /// /// Support for task management will be added later as part of the long-running task execution work. /// public sealed class A2AHostAgent { /// - /// Initializes a new instance of the SemanticKernelTravelAgent + /// Initializes a new instance of the class. /// + /// The to host. + /// The for the hosted agent. + /// The for handling agent tasks. public A2AHostAgent(AIAgent agent, AgentCard agentCard, TaskManager? taskManager = null) { Throw.IfNull(agent); @@ -36,19 +39,19 @@ public sealed class A2AHostAgent } /// - /// The associated + /// Gets the associated . /// public AIAgent? Agent { get; } /// - /// The associated + /// Gets the associated for handling agent tasks. /// public TaskManager? TaskManager { get; private set; } /// - /// Attach the to the provided + /// Attaches the to the provided . /// - /// + /// The to attach to. public void Attach(TaskManager taskManager) { Throw.IfNull(taskManager); @@ -59,9 +62,9 @@ public sealed class A2AHostAgent } /// - /// Handle a received message + /// Handles a received message. /// - /// The to handle + /// The to handle. /// The to monitor for cancellation requests. The default is . public async Task OnMessageReceivedAsync(MessageSendParams messageSend, CancellationToken cancellationToken = default) { @@ -89,9 +92,9 @@ public sealed class A2AHostAgent } /// - /// Return the associated with this hosted agent. + /// Gets the associated with this hosted agent. /// - /// Current URL for the agent + /// Current URL for the agent. /// The to monitor for cancellation requests. The default is . public Task GetAgentCardAsync(string agentUrl, CancellationToken cancellationToken = default) { diff --git a/dotnet/src/Microsoft.Agents.AI.A2A/Extensions/A2ACardResolverExtensions.cs b/dotnet/src/Microsoft.Agents.AI.A2A/Extensions/A2ACardResolverExtensions.cs index 9dbfcb277c..d9fe2a9a1c 100644 --- a/dotnet/src/Microsoft.Agents.AI.A2A/Extensions/A2ACardResolverExtensions.cs +++ b/dotnet/src/Microsoft.Agents.AI.A2A/Extensions/A2ACardResolverExtensions.cs @@ -29,10 +29,10 @@ public static class A2ACardResolverExtensions /// Retrieves an instance of for an existing A2A agent. /// /// - /// This method can be used to create AI agents for A2A agents whose hosts support one of the A2A discovery mechanisms: + /// Creates an AI agent for an A2A agent whose host supports one of the A2A discovery mechanisms: /// - /// Well-Known URI - /// Curated Registries (Catalog-Based Discovery) + /// Well-Known URI + /// Curated Registries (Catalog-Based Discovery) /// /// /// The to use for the agent creation. diff --git a/dotnet/src/Microsoft.Agents.AI.Abstractions/AgentAbstractionsJsonUtilities.cs b/dotnet/src/Microsoft.Agents.AI.Abstractions/AgentAbstractionsJsonUtilities.cs index d1d35c21bb..8943e29c79 100644 --- a/dotnet/src/Microsoft.Agents.AI.Abstractions/AgentAbstractionsJsonUtilities.cs +++ b/dotnet/src/Microsoft.Agents.AI.Abstractions/AgentAbstractionsJsonUtilities.cs @@ -24,13 +24,13 @@ public static partial class AgentAbstractionsJsonUtilities /// /// It additionally turns on the following settings: /// - /// Enables defaults. - /// Enables as the default ignore condition for properties. - /// Enables as the default number handling for number types. - /// + /// Enables defaults. + /// Enables as the default ignore condition for properties. + /// Enables as the default number handling for number types. + /// /// Enables when escaping JSON strings. /// Consuming applications must ensure that JSON outputs are adequately escaped before embedding in other document formats, such as HTML and XML. - /// + /// /// /// /// diff --git a/dotnet/src/Microsoft.Agents.AI/ChatClient/ChatClientAgentThread.cs b/dotnet/src/Microsoft.Agents.AI/ChatClient/ChatClientAgentThread.cs index 3152c28ea0..676e20dc53 100644 --- a/dotnet/src/Microsoft.Agents.AI/ChatClient/ChatClientAgentThread.cs +++ b/dotnet/src/Microsoft.Agents.AI/ChatClient/ChatClientAgentThread.cs @@ -80,8 +80,8 @@ public class ChatClientAgentThread : AgentThread /// /// This property may be null in the following cases: /// - /// The thread stores messages via the and not in the agent service. - /// This thread object is new and a server managed thread has not yet been created in the agent service. + /// The thread stores messages via the and not in the agent service. + /// This thread object is new and a server managed thread has not yet been created in the agent service. /// /// /// @@ -124,8 +124,8 @@ public class ChatClientAgentThread : AgentThread /// /// This property may be null in the following cases: /// - /// The thread stores messages in the agent service and just has an id to the remove thread, instead of in an . - /// This thread object is new it is not yet clear whether it will be backed by a server managed thread or an . + /// The thread stores messages in the agent service and just has an id to the remove thread, instead of in an . + /// This thread object is new it is not yet clear whether it will be backed by a server managed thread or an . /// /// ///