Skip to content

Commit 98ccafc

Browse files
committed
xmldoc fixes
1 parent 4ffceef commit 98ccafc

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Packages/com.unity.inputsystem/InputSystem/Actions/InputAction.cs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2113,11 +2113,11 @@ public unsafe double startTime
21132113
/// <para>
21142114
/// The value of this property determines how many bytes will be written
21152115
/// by <see cref="ReadValue(void*,int)"/>.
2116+
///
2117+
/// This property indirectly maps to the value of <see cref="InputControl.valueSizeInBytes"/> or
2118+
/// <see cref="InputBindingComposite{TValue}.valueSizeInBytes"/>.
21162119
/// </para>
21172120
/// </remarks>
2118-
/// <seealso cref="InputControl.valueSizeInBytes"/>
2119-
/// <seealso cref="InputBindingComposite.valueSizeInBytes"/>
2120-
/// <seealso cref="ReadValue(void*,int)"/>
21212121
public int valueSizeInBytes
21222122
{
21232123
get
@@ -2130,16 +2130,15 @@ public int valueSizeInBytes
21302130
}
21312131

21322132
/// <summary>
2133-
/// Read the value of the action as a raw byte buffer. This allows reading
2134-
/// values without having to know value types but also, unlike <see cref="ReadValueAsObject"/>,
2135-
/// without allocating GC heap memory.
2133+
/// Read the value of the action as a raw byte buffer.
21362134
/// </summary>
21372135
/// <param name="buffer">Memory buffer to read the value into.</param>
21382136
/// <param name="bufferSize">Size of buffer allocated at <paramref name="buffer"/>. Must be
21392137
/// at least <see cref="valueSizeInBytes"/>.</param>
2140-
/// <exception cref="ArgumentNullException"><paramref name="buffer"/> is <c>null</c>.</exception>
2141-
/// <exception cref="ArgumentException"><paramref name="bufferSize"/> is too small.</exception>
21422138
/// <remarks>
2139+
/// This allows reading values without having to know value types but also,
2140+
/// unlike <see cref="ReadValueAsObject"/>, without allocating GC heap memory.
2141+
/// </remarks>
21432142
/// <example>
21442143
/// <code>
21452144
/// // Read a Vector2 using the raw memory ReadValue API.
@@ -2155,7 +2154,8 @@ public int valueSizeInBytes
21552154
/// }
21562155
/// </code>
21572156
/// </example>
2158-
/// </remarks>
2157+
/// <exception cref="ArgumentNullException"><paramref name="buffer"/> is <c>null</c>.</exception>
2158+
/// <exception cref="ArgumentException"><paramref name="bufferSize"/> is too small.</exception>
21592159
/// <seealso cref="InputControlExtensions.ReadValueIntoBuffer"/>
21602160
/// <seealso cref="InputAction.ReadValue{TValue}"/>
21612161
/// <seealso cref="ReadValue{TValue}"/>

0 commit comments

Comments
 (0)