Skip to content

Commit c7e4482

Browse files
committed
improve documentation
1 parent 2c30068 commit c7e4482

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

Packages/com.unity.inputsystem/InputSystem/Actions/Composites/ButtonWithTwoModifiers.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ public class ButtonWithTwoModifiers : InputBindingComposite<float>
9898
/// By default, if the setting <see cref="InputSettings.shortcutKeysConsumeInput"/> is enabled,
9999
/// <see cref="modifier1"/> and <see cref="modifier2"/> are required to be in pressed state before or at the same
100100
/// time that <see cref="button"/> goes into pressed state for the composite as a whole to trigger. This means that binding to,
101-
/// for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> <c>shift</c> keys have to be pressed before pressing the <c>B</c> key.
101+
/// for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> and <c>shift</c> keys have to be pressed, in any order, before pressing the <c>B</c> key.
102102
/// This is the behavior usually expected with keyboard shortcuts.
103103
///
104104
/// This parameter can be used to bypass this behavior and allow any timing between <see cref="modifier1"/>, <see cref="modifier2"/>,
@@ -119,7 +119,7 @@ public enum ModifiersOrder
119119
/// By default, if the setting <see cref="InputSettings.shortcutKeysConsumeInput"/> is enabled,
120120
/// <see cref="modifier1"/> and <see cref="modifier2"/> are required to be in pressed state before or at the same
121121
/// time that <see cref="button"/> goes into pressed state for the composite as a whole to trigger. This means that binding to,
122-
/// for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> <c>shift</c> keys have to be pressed before pressing the <c>B</c> key.
122+
/// for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> and <c>shift</c> keys have to be pressed, in any order, before pressing the <c>B</c> key.
123123
/// This is the behavior usually expected with keyboard shortcuts.
124124
///
125125
/// If the setting <see cref="InputSettings.shortcutKeysConsumeInput"/> is disabled,
@@ -130,7 +130,7 @@ public enum ModifiersOrder
130130
/// <summary>
131131
/// <see cref="modifier1"/> and <see cref="modifier2"/> are required to be in pressed state before or at the same
132132
/// time that <see cref="button"/> goes into pressed state for the composite as a whole to trigger. This means that binding to,
133-
/// for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> <c>shift</c> keys have to be pressed before pressing the <c>B</c> key.
133+
/// for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> and <c>shift</c> keys have to be pressed, in any order, before pressing the <c>B</c> key.
134134
/// This is the behavior usually expected with keyboard shortcuts.
135135
/// </summary>
136136
Ordered = 1,
@@ -149,7 +149,7 @@ public enum ModifiersOrder
149149
/// By default, if the setting <see cref="InputSettings.shortcutKeysConsumeInput"/> is enabled,
150150
/// <see cref="modifier1"/> and <see cref="modifier2"/> are required to be in pressed state before or at the same
151151
/// time that <see cref="button"/> goes into pressed state for the composite as a whole to trigger. This means that binding to,
152-
/// for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> <c>shift</c> keys have to be pressed before pressing the <c>B</c> key.
152+
/// for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> and <c>shift</c> keys have to be pressed, in any order, before pressing the <c>B</c> key.
153153
/// This is the behavior usually expected with keyboard shortcuts.
154154
///
155155
/// If the setting <see cref="InputSettings.shortcutKeysConsumeInput"/> is disabled,

Packages/com.unity.inputsystem/InputSystem/Actions/Composites/OneModifierComposite.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ public enum ModifiersOrder
128128
/// <summary>
129129
/// if <see cref="binding"/> is bound to only <see cref="Controls.ButtonControl"/>s, then the composite requires
130130
/// <see cref="modifier"/> to be pressed <em>before</em> pressing <see cref="binding"/>. This means that binding to, for example,
131-
/// <c>Ctrl+B</c>, the <c>ctrl</c> keys have to be pressed before pressing the <c>B</c> key. This is the behavior usually expected
131+
/// <c>Ctrl+B</c>, the <c>ctrl</c> key have to be pressed before pressing the <c>B</c> key. This is the behavior usually expected
132132
/// with keyboard shortcuts.
133133
/// </summary>
134134
Ordered = 1,

Packages/com.unity.inputsystem/InputSystem/Actions/Composites/TwoModifiersComposite.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ public class TwoModifiersComposite : InputBindingComposite
9393
/// By default, if the setting <see cref="InputSettings.shortcutKeysConsumeInput"/> is enabled,
9494
/// if <see cref="binding"/> is bound to only <see cref="Controls.ButtonControl"/>s, then the composite requires
9595
/// both <see cref="modifier1"/> and <see cref="modifier2"/> to be pressed <em>before</em> pressing <see cref="binding"/>.
96-
/// This means that binding to, for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> and <c>shift</c> keys have to be pressed
96+
/// This means that binding to, for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> and <c>shift</c> keys have to be pressed, in any order,
9797
/// before pressing the <c>B</c> key. This is the behavior usually expected with keyboard shortcuts.
9898
///
9999
/// However, when binding, for example, <c>Ctrl+Shift+MouseDelta</c>, it should be possible to press <c>ctrl</c> and <c>shift</c>
@@ -119,7 +119,7 @@ public enum ModifiersOrder
119119
/// By default, if the setting <see cref="InputSettings.shortcutKeysConsumeInput"/> is enabled,
120120
/// if <see cref="binding"/> is bound to only <see cref="Controls.ButtonControl"/>s, then the composite requires
121121
/// both <see cref="modifier1"/> and <see cref="modifier2"/> to be pressed <em>before</em> pressing <see cref="binding"/>.
122-
/// This means that binding to, for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> and <c>shift</c> keys have to be pressed
122+
/// This means that binding to, for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> and <c>shift</c> keys have to be pressed, in any order,
123123
/// before pressing the <c>B</c> key. This is the behavior usually expected with keyboard shortcuts.
124124
///
125125
/// If the setting <see cref="InputSettings.shortcutKeysConsumeInput"/> is disabled,
@@ -130,7 +130,7 @@ public enum ModifiersOrder
130130
/// <summary>
131131
/// if <see cref = "binding" /> is bound to only <see cref = "Controls.ButtonControl" /> s, then the composite requires
132132
/// both <see cref="modifier1"/> and <see cref="modifier2"/> to be pressed <em>before</em> pressing <see cref="binding"/>.
133-
/// This means that binding to, for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> and <c>shift</c> keys have to be pressed
133+
/// This means that binding to, for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> and <c>shift</c> keys have to be pressed, in any order,
134134
/// before pressing the <c>B</c> key. This is the behavior usually expected with keyboard shortcuts.
135135
/// </summary>
136136
Ordered = 1,
@@ -149,7 +149,7 @@ public enum ModifiersOrder
149149
/// By default, if the setting <see cref="InputSettings.shortcutKeysConsumeInput"/> is enabled,
150150
/// if <see cref="binding"/> is bound to only <see cref="Controls.ButtonControl"/>s, then the composite requires
151151
/// both <see cref="modifier1"/> and <see cref="modifier2"/> to be pressed <em>before</em> pressing <see cref="binding"/>.
152-
/// This means that binding to, for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> and <c>shift</c> keys have to be pressed
152+
/// This means that binding to, for example, <c>Ctrl+Shift+B</c>, the <c>ctrl</c> and <c>shift</c> keys have to be pressed, in any order,
153153
/// before pressing the <c>B</c> key. This is the behavior usually expected with keyboard shortcuts.
154154
///
155155
/// If the setting <see cref="InputSettings.shortcutKeysConsumeInput"/> is disabled,

0 commit comments

Comments
 (0)