Skip to content

Commit bcadba7

Browse files
style
2 more...evidently you can't use <list> within a <param>
1 parent 0959618 commit bcadba7

File tree

1 file changed

+27
-55
lines changed

1 file changed

+27
-55
lines changed

com.unity.netcode.gameobjects/Runtime/Components/NetworkTransform.cs

Lines changed: 27 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1535,28 +1535,10 @@ internal bool SynchronizeScale
15351535
/// </list>
15361536
/// </remarks>
15371537
/// <param name="getCurrentState">
1538-
/// <list type="bullet">
1539-
/// <item>
1540-
/// <term>Authority</term>
1541-
/// <description>Always returns the space relative transform position (whether true or false).
1542-
/// </description></item>
1543-
/// <item>
1544-
/// <term>Non-authority:</term>
1545-
/// <list type="bullet">
1546-
/// <item>
1547-
/// <term>When false(default)</term>
1548-
/// <description>Returns the space relative transform position.
1549-
/// </description>
1550-
/// </item>
1551-
/// <item>
1552-
/// <term>When true</term>
1553-
/// <description>
1554-
/// Returns the authority position from the most recent state update.
1555-
/// </description>
1556-
/// </item>
1557-
/// </list>
1558-
/// </item>
1559-
/// </list>
1538+
/// Authority always returns the space relative transform position (whether true or false).<br />
1539+
/// Non-authority:<br />
1540+
/// When false (default): returns the space relative transform position.<br />
1541+
/// When true: returns the authority position from the most recent state update.
15601542
/// </param>
15611543
/// <returns><see cref="Vector3"/></returns>
15621544
[MethodImpl(MethodImplOptions.AggressiveInlining)]
@@ -1585,38 +1567,28 @@ public Vector3 GetSpaceRelativePosition(bool getCurrentState = false)
15851567
/// Helper method that returns the space relative rotation of the transform.
15861568
/// </summary>
15871569
/// <remarks>
1588-
/// If InLocalSpace is <see cref="true"/> then it returns the transform.localRotation.<br/>
1589-
/// If InLocalSpace is <see cref="false"/> then it returns the transform.rotation.<br/>
1590-
/// When invoked on the non-authority side:<br/>
1591-
/// If <see cref="getCurrentState"/> is true then it will return the most
1592-
/// current authority rotation from the most recent state update. This can be useful
1593-
/// if interpolation is enabled and you need to determine the final target rotation.<br/>
1594-
/// When invoked on the authority side:<br/>
1595-
/// It will always return the space relative rotation.<br/>
1596-
/// </remarks>
1597-
/// <param name="getCurrentState">
1570+
/// <list type="bullet">
1571+
/// <item><description>If InLocalSpace is <see cref="true"/> then it returns the transform.localRotation.</description></item>
1572+
/// <item><description>If InLocalSpace is <see cref="false"/> then it returns the transform.rotation.</description></item>
1573+
/// </list>
15981574
/// <list type="bullet">
15991575
/// <item>
1600-
/// <term>Authority</term>
1601-
/// <description>Always returns the space relative transform rotation (whether true or false).
1576+
/// <term>When invoked on the non-authority side:</term>
1577+
/// <description>If <see cref="getCurrentState"/> is true then it will return the most
1578+
/// current authority position from the most recent state update. This can be useful
1579+
/// if interpolation is enabled and you need to determine the final target rotation.
16021580
/// </description></item>
16031581
/// <item>
1604-
/// <term>Non-authority:</term>
1605-
/// <list type="bullet">
1606-
/// <item>
1607-
/// <term>When false(default)</term>
1608-
/// <description>Returns the space relative transform rotation.
1609-
/// </description>
1610-
/// </item>
1611-
/// <item>
1612-
/// <term>When true</term>
1613-
/// <description>
1614-
/// Returns the authority rotation from the most recent state update.
1615-
/// </description>
1616-
/// </item>
1617-
/// </list>
1618-
/// </item>
1582+
/// <term>When invoked on the authority side:</term>
1583+
/// <description>It will always return the space relative rotation.
1584+
/// </description></item>
16191585
/// </list>
1586+
/// </remarks>
1587+
/// <param name="getCurrentState">
1588+
/// Authority always returns the space relative transform rotation (whether true or false).<br />
1589+
/// Non-authority:<br />
1590+
/// When false (default): returns the space relative transform rotation.<br />
1591+
/// When true: returns the authority rotation from the most recent state update.
16201592
/// </param>
16211593
/// <returns><see cref="Quaternion"/></returns>
16221594
public Quaternion GetSpaceRelativeRotation(bool getCurrentState = false)
@@ -1635,17 +1607,17 @@ public Quaternion GetSpaceRelativeRotation(bool getCurrentState = false)
16351607
/// Helper method that returns the scale of the transform.
16361608
/// </summary>
16371609
/// <remarks>
1638-
/// When invoked on the non-authority side:
1610+
/// When invoked on the non-authority side:<br />
16391611
/// If <see cref="getCurrentState"/> is true then it will return the most
16401612
/// current authority scale from the most recent state update. This can be useful
1641-
/// if interpolation is enabled and you need to determine the final target scale.
1642-
/// When invoked on the authority side:
1613+
/// if interpolation is enabled and you need to determine the final target scale.<br />
1614+
/// When invoked on the authority side:<br />
16431615
/// It will always return the space relative scale.
16441616
/// </remarks>
16451617
/// <param name="getCurrentState">
1646-
/// Authority always returns the space relative transform scale (whether true or false).
1647-
/// Non-authority:
1648-
/// When false (default): returns the space relative transform scale
1618+
/// Authority always returns the space relative transform scale (whether true or false).<br />
1619+
/// Non-authority:<br />
1620+
/// When false (default): returns the space relative transform scale.<br />
16491621
/// When true: returns the authority scale from the most recent state update.
16501622
/// </param>
16511623
/// <returns><see cref="Vector3"/></returns>

0 commit comments

Comments
 (0)