Skip to content

Commit 8ad97b6

Browse files
committed
formatting small text adjustments
1 parent 58eeef6 commit 8ad97b6

File tree

1 file changed

+19
-7
lines changed
  • Packages/com.unity.inputsystem/InputSystem/Devices

1 file changed

+19
-7
lines changed

Packages/com.unity.inputsystem/InputSystem/Devices/Keyboard.cs

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -927,7 +927,6 @@ public class Keyboard : InputDevice, ITextInputReceiver
927927
/// Total number of key controls on a keyboard, i.e. the number of controls
928928
/// in <seealso cref="allKeys"/>.
929929
/// </summary>
930-
/// <remarks>The integer value represents the total number of key controls.</remarks>
931930
public const int KeyCount = (int)Key.OEM5;
932931

933932
/// <summary>
@@ -1022,7 +1021,6 @@ public event Action<char> onTextInput
10221021
/// </remarks>
10231022
/// <example>
10241023
/// <para>To subscribe to the onIMECompositionChange event, use the following sample code:</para>
1025-
///
10261024
/// <code>
10271025
/// using UnityEngine;
10281026
/// using UnityEngine.InputSystem;
@@ -1065,7 +1063,7 @@ public event Action<IMECompositionString> onIMECompositionChange
10651063
/// <seealso cref="Keyboard.imeSelected"/> for more IME settings and data.
10661064
/// </remarks>
10671065
/// <param name="enabled">
1068-
/// The new IME composition enabled state. True to enable the IME, false to disable it.
1066+
/// The IME composition enabled state. <see langword="true"/> to enable the IME, <see loanword="false"/> to disable it.
10691067
/// </param>
10701068
/// <example>
10711069
/// <code>
@@ -1637,6 +1635,7 @@ public string keyboardLayout
16371635
/// </summary>
16381636
/// <remarks>
16391637
/// <seealso cref="KeyControl"/> representing the backspace key.
1638+
///
16401639
/// On the Mac, this key may be labeled "delete" which however is a
16411640
/// key different from <seealso cref="deleteKey"/>.
16421641
/// </remarks>
@@ -1683,6 +1682,7 @@ public string keyboardLayout
16831682
/// </summary>
16841683
/// <remarks>
16851684
/// <seealso cref="KeyControl"/> representing the delete key.
1685+
///
16861686
/// On the Mac, the <seealso cref="backspaceKey"/> is also labeled "delete".
16871687
/// However, this is not this key.
16881688
/// </remarks>
@@ -1739,6 +1739,7 @@ public string keyboardLayout
17391739
/// </summary>
17401740
/// <remarks>
17411741
/// <seealso cref="KeyControl"/> representing the numpad divide key.
1742+
///
17421743
/// PC keyboards usually have a 17-key numpad layout that differs from the 18-key layout
17431744
/// we use for reference. The 18-key layout is usually found on Mac keyboards. The numpad
17441745
/// divide key usually is the <seealso cref="numpadEqualsKey"/> on PC keyboards.
@@ -1752,6 +1753,7 @@ public string keyboardLayout
17521753
/// </summary>
17531754
/// <remarks>
17541755
/// <seealso cref="KeyControl"/> representing the numpad multiply key.
1756+
///
17551757
/// PC keyboards usually have a 17-key numpad layout that differs from the 18-key layout
17561758
/// we use for reference. The 18-key layout is usually found on Mac keyboards. The numpad
17571759
/// multiply key usually is the <seealso cref="numpadMinusKey"/> on PC keyboards.
@@ -1764,6 +1766,7 @@ public string keyboardLayout
17641766
/// </summary>
17651767
/// <remarks>
17661768
/// <seealso cref="KeyControl"/> representing the numpad minus key.
1769+
///
17671770
/// PC keyboards usually have a 17-key numpad layout that differs from the 18-key layout
17681771
/// we use for reference. The 18-key layout is usually found on Mac keyboards. The numpad
17691772
/// minus key is usually <em>not</em> present on PC keyboards. Instead, the 17-key layout
@@ -1777,6 +1780,7 @@ public string keyboardLayout
17771780
/// </summary>
17781781
/// <remarks>
17791782
/// <seealso cref="KeyControl"/> representing the numpad plus key.
1783+
///
17801784
/// PC keyboards usually have a 17-key numpad layout that differs from the 18-key layout
17811785
/// we use for reference. The 18-key layout is usually found on Mac keyboards.
17821786
///
@@ -1794,6 +1798,7 @@ public string keyboardLayout
17941798
/// </summary>
17951799
/// <remarks>
17961800
/// <seealso cref="KeyControl"/> representing the numpad period key.
1801+
///
17971802
/// This key is the same in 17-key and 18-key numpad layouts.
17981803
/// </remarks>
17991804
public KeyControl numpadPeriodKey => this[Key.NumpadPeriod];
@@ -1804,6 +1809,7 @@ public string keyboardLayout
18041809
/// </summary>
18051810
/// <remarks>
18061811
/// <seealso cref="KeyControl"/> representing the numpad equals key.
1812+
///
18071813
/// PC keyboards usually have a 17-key numpad layout that differs from the 18-key layout
18081814
/// we use for reference. The 18-key layout is usually found on Mac keyboards.
18091815
///
@@ -1972,6 +1978,7 @@ public string keyboardLayout
19721978
/// </summary>
19731979
/// <remarks>
19741980
/// <seealso cref="KeyControl"/> representing <seealso cref="Key.OEM1"/>.
1981+
///
19751982
/// Keyboards may have additional keys that are not part of the standardized 104-key keyboard layout
19761983
/// (105 in the case of an 18-key numpad). For example, many non-English keyboard layouts have an additional
19771984
/// key in-between <seealso cref="leftShiftKey"/> and <seealso cref="zKey"/>.
@@ -1987,6 +1994,7 @@ public string keyboardLayout
19871994
/// </summary>
19881995
/// <remarks>
19891996
/// <seealso cref="KeyControl"/> representing <seealso cref="Key.OEM2"/>.
1997+
///
19901998
/// Keyboards may have additional keys that are not part of the standardized 104-key keyboard layout
19911999
/// (105 in the case of an 18-key numpad). For example, many non-English keyboard layouts have an additional
19922000
/// key in-between <seealso cref="leftShiftKey"/> and <seealso cref="zKey"/>.
@@ -2002,6 +2010,7 @@ public string keyboardLayout
20022010
/// </summary>
20032011
/// <remarks>
20042012
/// <seealso cref="KeyControl"/> representing <seealso cref="Key.OEM3"/>.
2013+
///
20052014
/// Keyboards may have additional keys that are not part of the standardized 104-key keyboard layout
20062015
/// (105 in the case of an 18-key numpad). For example, many non-English keyboard layouts have an additional
20072016
/// key in-between <seealso cref="leftShiftKey"/> and <seealso cref="zKey"/>.
@@ -2017,6 +2026,7 @@ public string keyboardLayout
20172026
/// </summary>
20182027
/// <remarks>
20192028
/// <seealso cref="KeyControl"/> representing <seealso cref="Key.OEM4"/>.
2029+
///
20202030
/// Keyboards may have additional keys that are not part of the standardized 104-key keyboard layout
20212031
/// (105 in the case of an 18-key numpad). For example, many non-English keyboard layouts have an additional
20222032
/// key in-between <seealso cref="leftShiftKey"/> and <seealso cref="zKey"/>.
@@ -2032,6 +2042,7 @@ public string keyboardLayout
20322042
/// </summary>
20332043
/// <remarks>
20342044
/// <seealso cref="KeyControl"/> representing <seealso cref="Key.OEM5"/>.
2045+
///
20352046
/// Keyboards may have additional keys that are not part of the standardized 104-key keyboard layout
20362047
/// (105 in the case of an 18-key numpad). For example, many non-English keyboard layouts have an additional
20372048
/// key in-between <seealso cref="leftShiftKey"/> and <seealso cref="zKey"/>.
@@ -2047,6 +2058,7 @@ public string keyboardLayout
20472058
/// </summary>
20482059
/// <remarks>
20492060
/// <seealso cref="ButtonControl"/> representing a combined left and right shift key.
2061+
///
20502062
/// This is a <seealso cref="InputControl.synthetic"/> button which is considered pressed whenever the left and/or
20512063
/// right shift key is pressed.
20522064
/// </remarks>
@@ -2057,6 +2069,7 @@ public string keyboardLayout
20572069
/// </summary>
20582070
/// <remarks>
20592071
/// <seealso cref="ButtonControl"/> representing a combined left and right ctrl key.
2072+
///
20602073
/// This is a <seealso cref="InputControl.synthetic"/> button which is considered pressed whenever the left and/or
20612074
/// right ctrl key is pressed.
20622075
/// </remarks>
@@ -2067,6 +2080,7 @@ public string keyboardLayout
20672080
/// </summary>
20682081
/// <remarks>
20692082
/// <seealso cref="ButtonControl"/> representing a combined left and right alt key.
2083+
///
20702084
/// This is a <seealso cref="InputControl.synthetic"/> button which is considered pressed whenever the left and/or
20712085
/// right alt key is pressed.
20722086
/// </remarks>
@@ -2076,9 +2090,8 @@ public string keyboardLayout
20762090
/// True when IME composition is enabled. Requires <seealso cref="Keyboard.SetIMEEnabled"/> to be called to enable IME, and the user to enable it at the OS level.
20772091
/// </summary>
20782092
/// <remarks>
2079-
/// <seealso cref="ButtonControl"/> representing a combined left and right alt key.
20802093
/// Some languages use complex input methods which involve opening windows to insert characters.
2081-
/// Typically, this is not desirable while playing a game, as games may just interpret key strokes as game input, not as text.
2094+
/// Typically, this is not desirable while playing a game, as games may just interpret keystrokes as game input, not as text.
20822095
///
20832096
/// See <seealso cref="Keyboard.SetIMEEnabled"/> for turning IME on/off
20842097
/// </remarks>
@@ -2090,7 +2103,6 @@ public string keyboardLayout
20902103
/// <param name="key">Key code of key control to return.</param>
20912104
/// <exception cref="ArgumentOutOfRangeException">The given <paramref name="key"/> is not valid.</exception>
20922105
/// <remarks>
2093-
/// <seealso cref="KeyControl"/> representing a combined left and right alt key.
20942106
/// This is equivalent to <c>allKeys[(int)key - 1]</c>.
20952107
/// </remarks>
20962108
public KeyControl this[Key key]
@@ -2322,7 +2334,7 @@ protected override void RefreshConfiguration()
23222334
/// <summary>
23232335
/// Called when text input on the keyboard is received.
23242336
/// </summary>
2325-
/// <param name="character">Char value that represents the character that has been entered.</param>
2337+
/// <param name="character">A char type value that represents the character that has been entered.</param>
23262338
/// <remarks>
23272339
/// The system will call this method automatically whenever a <seealso cref="TextEvent"/> is
23282340
/// received that targets the keyboard device. Subscribe to this event by using <seealso cref="onTextInput"/>.

0 commit comments

Comments
 (0)