From 430a1b278e8d7f0d66dba4326b7e15240a90abe1 Mon Sep 17 00:00:00 2001
From: Aurimas Petrovas <>
Date: Wed, 11 Sep 2024 15:15:33 +0300
Subject: [PATCH] fix summary tag

---
 .../Runtime/Communicator/ICommunicator.cs     | 71 +++++++++----------
 1 file changed, 35 insertions(+), 36 deletions(-)

diff --git a/com.unity.ml-agents/Runtime/Communicator/ICommunicator.cs b/com.unity.ml-agents/Runtime/Communicator/ICommunicator.cs
index 30bc323350..c39281990d 100644
--- a/com.unity.ml-agents/Runtime/Communicator/ICommunicator.cs
+++ b/com.unity.ml-agents/Runtime/Communicator/ICommunicator.cs
@@ -91,42 +91,41 @@ internal struct UnityRLInputParameters
     internal delegate void RLInputReceivedHandler(UnityRLInputParameters inputParams);
 
     /// <summary>
-    /**
-    This is the interface of the Communicators.
-    This does not need to be modified nor implemented to create a Unity environment.
-
-    When the Unity Communicator is initialized, it will wait for the External Communicator
-    to be initialized as well. The two communicators will then exchange their first messages
-    that will usually contain information for initialization (information that does not need
-    to be resent at each new exchange).
-
-    By convention a Unity input is from External to Unity and a Unity output is from Unity to
-    External. Inputs and outputs are relative to Unity.
-
-    By convention, when the Unity Communicator and External Communicator call exchange, the
-    exchange is NOT simultaneous but sequential. This means that when a side of the
-    communication calls exchange, the other will receive the result of its previous
-    exchange call.
-    This is what happens when A calls exchange a single time:
-    A sends data_1 to B -> B receives data_1 -> B generates and sends data_2 -> A receives data_2
-    When A calls exchange, it sends data_1 and receives data_2
-
-    Since the messages are sent back and forth with exchange and simultaneously when calling
-    initialize, External sends two messages at initialization.
-
-    The structure of the messages is as follows:
-    UnityMessage
-    ...Header
-    ...UnityOutput
-    ......UnityRLOutput
-    ......UnityRLInitializationOutput
-    ...UnityInput
-    ......UnityRLInput
-    ......UnityRLInitializationInput
-
-    UnityOutput and UnityInput can be extended to provide functionalities beyond RL
-    UnityRLOutput and UnityRLInput can be extended to provide new RL functionalities
-     */
+    /// This is the interface of the Communicators.
+    /// This does not need to be modified nor implemented to create a Unity environment.
+    ///
+    /// When the Unity Communicator is initialized, it will wait for the External Communicator
+    /// to be initialized as well. The two communicators will then exchange their first messages
+    /// that will usually contain information for initialization (information that does not need
+    ///  to be resent at each new exchange).
+    ///
+    /// By convention a Unity input is from External to Unity and a Unity output is from Unity to
+    /// External. Inputs and outputs are relative to Unity.
+    ///
+    /// By convention, when the Unity Communicator and External Communicator call exchange, the
+    /// exchange is NOT simultaneous but sequential. This means that when a side of the
+    /// communication calls exchange, the other will receive the result of its previous
+    /// xchange call.
+    /// This is what happens when A calls exchange a single time:
+    /// A sends data_1 to B -> B receives data_1 -> B generates and sends data_2 -> A receives data_2
+    /// When A calls exchange, it sends data_1 and receives data_2
+    ///
+    /// Since the messages are sent back and forth with exchange and simultaneously when calling
+    /// initialize, External sends two messages at initialization.
+    ///
+    /// The structure of the messages is as follows:
+    /// UnityMessage
+    /// ...Header
+    /// ...UnityOutput
+    /// ......UnityRLOutput
+    /// ......UnityRLInitializationOutput
+    /// ...UnityInput
+    /// ......UnityRLInput
+    /// ......UnityRLInitializationInput
+    ///
+    /// UnityOutput and UnityInput can be extended to provide functionalities beyond RL
+    /// UnityRLOutput and UnityRLInput can be extended to provide new RL functionalities
+    ///
     /// </summary>
     public interface ICommunicator : IDisposable
     {