GUACAMOLE-352: Clarify that Guacamole.Keyboard can be given an Element or a Document.

This commit is contained in:
Michael Jumper
2017-12-18 11:20:13 -08:00
parent 86d9cc1248
commit 5136b1cf8e

View File

@@ -25,7 +25,7 @@ var Guacamole = Guacamole || {};
* which represent keys as their corresponding X11 keysym. * which represent keys as their corresponding X11 keysym.
* *
* @constructor * @constructor
* @param {Element} [element] * @param {Element|Document} [element]
* The Element to use to provide keyboard events. If omitted, at least one * The Element to use to provide keyboard events. If omitted, at least one
* Element must be manually provided through the listenTo() function for * Element must be manually provided through the listenTo() function for
* the Guacamole.Keyboard instance to have any effect. * the Guacamole.Keyboard instance to have any effect.
@@ -1186,7 +1186,7 @@ Guacamole.Keyboard = function Keyboard(element) {
* events signalled through this Guacamole.Keyboard's onkeydown and * events signalled through this Guacamole.Keyboard's onkeydown and
* onkeyup handlers. * onkeyup handlers.
* *
* @param {Element} element * @param {Element|Document} element
* The Element to attach event listeners to for the sake of handling * The Element to attach event listeners to for the sake of handling
* key or input events. * key or input events.
*/ */