DOCF-3045 Clarified information about key layout, text input and key controls#1695
Conversation
There was a problem hiding this comment.
Changes look reasonable. Happy to approve.
However these is a test failure with the documentation
Looks like the CapsLock link and the Controls.KeyControl link aren't valid
playmode Test Failure: DocumentationBasedAPIVerficationTests.API_DocsDoNotHaveXMLDocErrors
Expected:
But was: < "[23-06-28 01:22:56.342]Warning:[MetadataCommand.ExtractMetadata]Invalid cref value "!:A" found in triple-slash-comments for KeyControl defined in Packages/com.unity.inputsystem/InputSystem/Controls/KeyControl.cs Line 36, ignored.", "[23-06-28 01:22:56.343]Warning:[MetadataCommand.ExtractMetadata]Invalid cref value "!:CapsLock" found in triple-slash-comments for KeyControl defined in Packages/com.unity.inputsystem/InputSystem/Controls/KeyControl.cs Line 36, ignored.", "[23-06-28 01:22:56.343]Warning:[MetadataCommand.ExtractMetadata]Invalid cref value "!:see Controls.KeyControl" found in triple-slash-comments for keyCode defined in Packages/com.unity.inputsystem/InputSystem/Controls/KeyControl.cs Line 46, ignored." >
…//github.com/Unity-Technologies/InputSystem into DOCF-3045-keycodes-text-input-mapping-in-JIS
lyndon-unity
left a comment
lyndon-unity
left a comment
There was a problem hiding this comment.
Looks like a clean updated, most CI passing, one unrelated failure, I've just triggered that again to be sure.
2 participants
Description
https://jira.unity3d.com/browse/DOCF-3045
Some API documentation did not clearly distinguish between key input controls and keyboard text input, particularly in relation to variations in keyboard layout due to system language. This was causing confusion for users who were (incorrectly) trying to read text input using keycodes.
Changes made
Added documentation to clarify usage of KeyControl and Keyboard.Key, and added links to Keyboard.onTextInput.