Skip to content

Commit a30eed4

Browse files
committed
Remaining fixes
1 parent c15ad66 commit a30eed4

File tree

5 files changed

+17
-17
lines changed

5 files changed

+17
-17
lines changed

com.unity.netcode.gameobjects/Runtime/Messaging/GenerateSerializationForGenericParameterAttribute.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ namespace Unity.Netcode
1919
/// <br/>
2020
/// The parameter is indicated by index (and is 0-indexed); for example:
2121
/// <br/>
22-
/// <code>
22+
/// <c>
2323
/// [SerializesGenericParameter(1)]
2424
/// public class MyClass&lt;TTypeOne, TTypeTwo&gt;
2525
/// {
2626
/// }
27-
/// </code>
27+
/// </c>
2828
/// <br/>
2929
/// This tells the code generation for <see cref="NetworkVariableSerialization{T}"/> to generate
3030
/// serialized code for <b>TTypeTwo</b> (generic parameter 1).
@@ -38,7 +38,7 @@ namespace Unity.Netcode
3838
/// <br/>
3939
/// This attribute is properly inherited by subclasses. For example:
4040
/// <br/>
41-
/// <code>
41+
/// <c>
4242
/// [SerializesGenericParameter(0)]
4343
/// public class MyClass&lt;T&gt;
4444
/// {
@@ -63,7 +63,7 @@ namespace Unity.Netcode
6363
/// public MySubclass2&lt;Bar&gt; TheValue;
6464
/// public MySubclass3&lt;Baz, Qux&gt; TheValue;
6565
/// }
66-
/// </code>
66+
/// </c>
6767
/// <br/>
6868
/// The above code will trigger generation of serialization code for <b>Foo</b> (passed directly to the
6969
/// base class), <b>Bar</b> (passed indirectly to the base class), <b>Baz</b> (passed indirectly to the base class),

com.unity.netcode.gameobjects/Runtime/Serialization/FastBufferWriter.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -455,9 +455,9 @@ public void WriteNetworkSerializable<T>(T[] array, int count = -1, int offset =
455455
/// <summary>
456456
/// Write a NativeArray of INetworkSerializables
457457
/// </summary>
458-
/// <param name="array">The value to write</param>
459-
/// <param name="count"></param>
460-
/// <param name="offset"></param>
458+
/// <param name="array">The NativeArray containing the values to write</param>
459+
/// <param name="count">The number of elements to write. If -1 (default), writes array.Length - offset elements</param>
460+
/// <param name="offset">The starting position in the array. Defaults to 0</param>
461461
/// <typeparam name="T">The type of the value</typeparam>
462462
public void WriteNetworkSerializable<T>(NativeArray<T> array, int count = -1, int offset = 0) where T : unmanaged, INetworkSerializable
463463
{
@@ -473,10 +473,10 @@ public void WriteNetworkSerializable<T>(NativeArray<T> array, int count = -1, in
473473
/// <summary>
474474
/// Write a NativeList of INetworkSerializables
475475
/// </summary>
476-
/// <param name="array">The value to write</param>
477-
/// <param name="count"></param>
478-
/// <param name="offset"></param>
479-
/// <typeparam name="T"></typeparam>
476+
/// <param name="array">The NativeArray containing the values to write</param>
477+
/// <param name="count">The number of elements to write. If -1 (default), writes array.Length - offset elements</param>
478+
/// <param name="offset">The starting position in the array. Defaults to 0/param>
479+
/// <typeparam name="T">The type of the value</typeparam>
480480
public void WriteNetworkSerializable<T>(NativeList<T> array, int count = -1, int offset = 0) where T : unmanaged, INetworkSerializable
481481
{
482482
int sizeInTs = count != -1 ? count : array.Length - offset;

com.unity.netcode.gameobjects/Runtime/Serialization/NetworkObjectReference.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ public ulong NetworkObjectId
2525
/// Creates a new instance of the <see cref="NetworkObjectReference"/> struct.
2626
/// </summary>
2727
/// <param name="networkObject">The <see cref="NetworkObject"/> to reference.</param>
28-
/// <exception cref="ArgumentNullException"></exception>
29-
/// <exception cref="ArgumentException"></exception>
28+
/// <exception cref="ArgumentNullException">Thrown when networkObject is null (creates a null reference instead of throwing)</exception>
29+
/// <exception cref="ArgumentException">Thrown when the NetworkObject is not spawned. NetworkObjectReference can only be created from spawned NetworkObjects</exception>
3030
public NetworkObjectReference(NetworkObject networkObject)
3131
{
3232
if (networkObject == null)
@@ -47,8 +47,8 @@ public NetworkObjectReference(NetworkObject networkObject)
4747
/// Creates a new instance of the <see cref="NetworkObjectReference"/> struct.
4848
/// </summary>
4949
/// <param name="gameObject">The GameObject from which the <see cref="NetworkObject"/> component will be referenced.</param>
50-
/// <exception cref="ArgumentNullException"></exception>
51-
/// <exception cref="ArgumentException"></exception>
50+
/// <exception cref="ArgumentNullException">Thrown when networkObject is null (creates a null reference instead of throwing)</exception>
51+
/// <exception cref="ArgumentException">Thrown when the NetworkObject is not spawned. NetworkObjectReference can only be created from spawned NetworkObjects</exception>
5252
public NetworkObjectReference(GameObject gameObject)
5353
{
5454
if (gameObject == null)

com.unity.netcode.gameobjects/Runtime/Spawning/NetworkPrefabHandler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public interface INetworkPrefabInstanceHandler
2424
/// <param name="ownerClientId">the owner for the <see cref="NetworkObject"/> to be instantiated</param>
2525
/// <param name="position">the initial/default position for the <see cref="NetworkObject"/> to be instantiated</param>
2626
/// <param name="rotation">the initial/default rotation for the <see cref="NetworkObject"/> to be instantiated</param>
27-
/// <returns></returns>
27+
/// <returns>The instantiated NetworkObject instance. Returns null if instantiation fails.</returns>
2828
NetworkObject Instantiate(ulong ownerClientId, Vector3 position, Quaternion rotation);
2929

3030
/// <summary>

com.unity.netcode.gameobjects/Runtime/Transports/NetworkTransport.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ namespace Unity.Netcode
66
/// <summary>
77
/// The generic transport class all Netcode for GameObjects network transport implementations
88
/// derive from. Use this class to add a custom transport.
9-
/// <see cref="Transports.UTP.UnityTransport"> for an example of how a transport is integrated</seealso>
9+
/// <see cref="Transports.UTP.UnityTransport"/> for an example of how a transport is integrated
1010
/// </summary>
1111
public abstract class NetworkTransport : MonoBehaviour
1212
{

0 commit comments

Comments
 (0)