fix: Update API docs for MaxPayloadSize (#2877)

jabbacakes · web-flow · commit d97d968a47a9 · 2024-04-17T16:55:57.000+01:00
* Update API docs for MaxPayloadSize

* Update to API remark following review
diff --git a/com.unity.netcode.gameobjects/Runtime/Transports/UTP/UnityTransport.cs b/com.unity.netcode.gameobjects/Runtime/Transports/UTP/UnityTransport.cs
@@ -202,11 +202,12 @@ public int MaxPacketQueueSize
             set => m_MaxPacketQueueSize = value;
         }
 
-        [Tooltip("The maximum size of an unreliable payload that can be handled by the transport.")]
+        [Tooltip("The maximum size of an unreliable payload that can be handled by the transport. The memory for MaxPayloadSize is allocated once per connection and is released when the connection is closed.")]
         [SerializeField]
         private int m_MaxPayloadSize = InitialMaxPayloadSize;
 
         /// <summary>The maximum size of an unreliable payload that can be handled by the transport.</summary>
+        /// <remarks>The memory for MaxPayloadSize is allocated once per connection and is released when the connection is closed.</remarks>
         public int MaxPayloadSize
         {
             get => m_MaxPayloadSize;

Original file line number	Diff line number	Diff line change
`@@ -202,11 +202,12 @@ public int MaxPacketQueueSize`
`202`	`202`	`set => m_MaxPacketQueueSize = value;`
`203`	`203`	`}`
`204`	`204`
`205`		`- [Tooltip("The maximum size of an unreliable payload that can be handled by the transport.")]`
	`205`	`+ [Tooltip("The maximum size of an unreliable payload that can be handled by the transport. The memory for MaxPayloadSize is allocated once per connection and is released when the connection is closed.")]`
`206`	`206`	`[SerializeField]`
`207`	`207`	`private int m_MaxPayloadSize = InitialMaxPayloadSize;`
`208`	`208`
`209`	`209`	`/// <summary>The maximum size of an unreliable payload that can be handled by the transport.</summary>`
	`210`	`+ /// <remarks>The memory for MaxPayloadSize is allocated once per connection and is released when the connection is closed.</remarks>`
`210`	`211`	`public int MaxPayloadSize`
`211`	`212`	`{`
`212`	`213`	`get => m_MaxPayloadSize;`