fix: Update API docs for MaxPayloadSize (#2877)

* Update API docs for MaxPayloadSize

* Update to API remark following review
This commit is contained in:
Amy Reeve 2024-04-17 16:55:57 +01:00 коммит произвёл GitHub
Родитель d90292da99
Коммит d97d968a47
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: B5690EEEBB952194
1 изменённых файлов: 2 добавлений и 1 удалений

Просмотреть файл

@ -202,11 +202,12 @@ namespace Unity.Netcode.Transports.UTP
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;