docs(new): add TSDoc comments to Keyboard #6099
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This is #6068 rebased with some tweaks applied. |
jackfranklin
commented
Jun 25, 2020
| @@ -22,15 +22,81 @@ type KeyDescription = Required< | |||
| Pick<KeyDefinition, 'keyCode' | 'key' | 'text' | 'code' | 'location'> | |||
| >; | |||
|
|
|||
| /** | |||
| * Keyboard provides an api for managing a virtual keyboard. | |||
| * The high level api is {@link Keyboard."type"}, | |||
There was a problem hiding this comment.
@TimvdLippe you have to quote the type here as it's a TSDoc keyword - that's why the link didn't work before. Bit obscure but ah well.
TimvdLippe
approved these changes
Jun 25, 2020
paullewis
approved these changes
Jun 25, 2020
mathiasbynens
changed the title
mathiasbynens
pushed a commit
that referenced
this pull request
Jun 25, 2020
Co-authored-by: Tim van der Lippe <tvanderlippe@google.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.