Skip to content

Commit 1f81ebd

Browse files
style - PVP
Minor XML API fixes.
1 parent 4a9775a commit 1f81ebd

File tree

2 files changed

+7
-9
lines changed

2 files changed

+7
-9
lines changed

com.unity.netcode.gameobjects/Runtime/Components/Helpers/AttachableBehaviour.cs

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,10 @@ public enum AttachState
117117
private Vector3 m_OriginalLocalPosition;
118118
private Quaternion m_OriginalLocalRotation;
119119

120-
/// <inheritdoc/>
121-
/// <remarks>
120+
/// <summary>
122121
/// If you create a custom <see cref="AttachableBehaviour"/> and override this method, you must invoke
123122
/// this base instance of <see cref="Awake"/>.
124-
/// </remarks>
123+
/// </summary>
125124
protected virtual void Awake()
126125
{
127126
m_DefaultParent = transform.parent == null ? gameObject : transform.parent.gameObject;
@@ -218,8 +217,8 @@ private void UpdateAttachedState()
218217
/// For customized/derived <see cref="AttachableBehaviour"/>s, override this method to receive notifications
219218
/// when the <see cref="AttachState"/> has changed.
220219
/// </summary>
221-
/// <param name="attachState">the new <see cref="AttachState"/>.</param>
222-
/// <param name="attachableNode"></param>
220+
/// <param name="attachState">The new <see cref="AttachState"/>.</param>
221+
/// <param name="attachableNode">The <see cref="AttachableNode"/> being attached to or from. Will be null when completely detatched.</param>
223222
protected virtual void OnAttachStateChanged(AttachState attachState, AttachableNode attachableNode)
224223
{
225224

@@ -275,7 +274,7 @@ internal void InternalAttach(AttachableNode attachableNode)
275274
/// Both the <see cref="AttachableNode"/> and this <see cref="AttachableBehaviour"/> instances should be in the spawned state before this
276275
/// is invoked.
277276
/// </remarks>
278-
/// <param name="parent">The <see cref="NetworkBehaviour"/> to be applied or null to reparent under its original <see cref="GameObject"/> when spawned.</param>
277+
/// <param name="attachableNode">The <see cref="AttachableNode"/> to attach this instance to.</param>
279278
public void Attach(AttachableNode attachableNode)
280279
{
281280
if (!IsSpawned)

com.unity.netcode.gameobjects/Runtime/Components/Helpers/ComponentController.cs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,10 @@ protected virtual void OnValidate()
9696
}
9797
#endif
9898

99-
/// <inheritdoc/>
100-
/// <remarks>
99+
/// <summary>
101100
/// Also checks to assure all <see cref="Component"/> entries are valid and creates a final table of
102101
/// <see cref="Component"/>s paired to their <see cref="PropertyInfo"/>.
103-
/// </remarks>
102+
/// </summary>
104103
protected virtual void Awake()
105104
{
106105
var emptyEntries = 0;

0 commit comments

Comments
 (0)