diff --git a/com.unity.netcode.gameobjects/CHANGELOG.md b/com.unity.netcode.gameobjects/CHANGELOG.md index 6d28df038b..b8756b33c7 100644 --- a/com.unity.netcode.gameobjects/CHANGELOG.md +++ b/com.unity.netcode.gameobjects/CHANGELOG.md @@ -31,6 +31,7 @@ Additional documentation and release notes are available at [Multiplayer Documen - Fixed `NetworkAnimator` issue where the host client was receiving the ClientRpc animation updates when the host was the owner.(#2309) - Fixed `NetworkAnimator` issue with using pooled objects and when specific properties are cleaned during despawn and destroy.(#2309) - Fixed issue where `NetworkAnimator` was checking for animation changes when the associated `NetworkObject` was not spawned.(#2309) +- Corrected an issue with the documentation for BufferSerializer (#2401) ## [1.2.0] - 2022-11-21 diff --git a/com.unity.netcode.gameobjects/Runtime/Serialization/BufferSerializer.cs b/com.unity.netcode.gameobjects/Runtime/Serialization/BufferSerializer.cs index 4f35888d3c..4afd4579b5 100644 --- a/com.unity.netcode.gameobjects/Runtime/Serialization/BufferSerializer.cs +++ b/com.unity.netcode.gameobjects/Runtime/Serialization/BufferSerializer.cs @@ -7,14 +7,10 @@ namespace Unity.Netcode /// /// Two-way serializer wrapping FastBufferReader or FastBufferWriter. /// - /// Implemented as a ref struct for two reasons: - /// 1. The BufferSerializer cannot outlive the FBR/FBW it wraps or using it will cause a crash - /// 2. The BufferSerializer must always be passed by reference and can't be copied + /// Implemented as a ref struct to help enforce the requirement that + /// the BufferSerializer cannot outlive the FBR/FBW it wraps or using it will cause a crash /// - /// Ref structs help enforce both of those rules: they can't ref live the stack context in which they were - /// created, and they're always passed by reference no matter what. - /// - /// BufferSerializer doesn't wrapp FastBufferReader or FastBufferWriter directly because it can't. + /// BufferSerializer doesn't wrap FastBufferReader or FastBufferWriter directly because it can't. /// ref structs can't implement interfaces, and in order to be able to have two different implementations with /// the same interface (which allows us to avoid an "if(IsReader)" on every call), the thing directly wrapping /// the struct has to implement an interface. So IReaderWriter exists as the interface,