GUAC-791: Fix type expressions to comply with JSDoc 3.

This commit is contained in:
Michael Jumper
2015-12-14 13:53:00 -08:00
parent 91f8f5b06b
commit 2959513d95
18 changed files with 132 additions and 132 deletions

View File

@@ -36,7 +36,7 @@ Guacamole.OnScreenKeyboard = function(layout) {
/**
* Reference to this Guacamole.OnScreenKeyboard.
*
* @type Guacamole.OnScreenKeyboard
* @type {Guacamole.OnScreenKeyboard}
*/
var osk = this;
@@ -46,7 +46,7 @@ Guacamole.OnScreenKeyboard = function(layout) {
* released.
*
* @private
* @type Object.<String, Number>
* @type {Object.<String, Number>}
*/
var modifierKeysyms = {};
@@ -55,7 +55,7 @@ Guacamole.OnScreenKeyboard = function(layout) {
* pressed, it may not be in this map at all, but all pressed keys will
* have a corresponding mapping to true.
*
* @type Object.<String, Boolean>
* @type {Object.<String, Boolean>}
*/
var pressed = {};
@@ -66,7 +66,7 @@ Guacamole.OnScreenKeyboard = function(layout) {
* experience rounding error due to unit conversions.
*
* @private
* @type ScaledElement[]
* @type {ScaledElement[]}
*/
var scaledElements = [];
@@ -133,7 +133,7 @@ Guacamole.OnScreenKeyboard = function(layout) {
* while non-zero, mouse events will have no effect.
*
* @private
* @type Number
* @type {Number}
*/
var ignoreMouse = 0;
@@ -175,7 +175,7 @@ Guacamole.OnScreenKeyboard = function(layout) {
* The width of this ScaledElement, in arbitrary units, relative to
* other ScaledElements.
*
* @type Number
* @type {Number}
*/
this.width = width;
@@ -183,7 +183,7 @@ Guacamole.OnScreenKeyboard = function(layout) {
* The height of this ScaledElement, in arbitrary units, relative to
* other ScaledElements.
*
* @type Number
* @type {Number}
*/
this.height = height;
@@ -396,7 +396,7 @@ Guacamole.OnScreenKeyboard = function(layout) {
* The number of mousemove events to require before re-enabling mouse
* event handling after receiving a touch event.
*
* @type Number
* @type {Number}
*/
this.touchMouseThreshold = 3;
@@ -419,7 +419,7 @@ Guacamole.OnScreenKeyboard = function(layout) {
/**
* The keyboard layout provided at time of construction.
*
* @type Guacamole.OnScreenKeyboard.Layout
* @type {Guacamole.OnScreenKeyboard.Layout}
*/
this.layout = new Guacamole.OnScreenKeyboard.Layout(layout);
@@ -535,7 +535,7 @@ Guacamole.OnScreenKeyboard = function(layout) {
* Map of all key names to their corresponding set of keys. Each key name
* may correspond to multiple keys due to the effect of modifiers.
*
* @type Object.<String, Guacamole.OnScreenKeyboard.Key[]>
* @type {Object.<String, Guacamole.OnScreenKeyboard.Key[]>}
*/
this.keys = getKeys(layout.keys);
@@ -793,7 +793,7 @@ Guacamole.OnScreenKeyboard.Layout = function(template) {
* informational purposes only, but it is recommend to conform to the
* [language code]_[country code] format.
*
* @type String
* @type {String}
*/
this.language = template.language;
@@ -801,7 +801,7 @@ Guacamole.OnScreenKeyboard.Layout = function(template) {
* The type of keyboard layout, such as "qwerty". This property is for
* informational purposes only, and does not conform to any standard.
*
* @type String
* @type {String}
*/
this.type = template.type;
@@ -811,7 +811,7 @@ Guacamole.OnScreenKeyboard.Layout = function(template) {
* implicitly. In all cases, the name property of the key object will be
* taken from the name given in the mapping.
*
* @type Object.<String, Number|String|Guacamole.OnScreenKeyboard.Key|Guacamole.OnScreenKeyboard.Key[]>
* @type {Object.<String, Number|String|Guacamole.OnScreenKeyboard.Key|Guacamole.OnScreenKeyboard.Key[]>}
*/
this.keys = template.keys;
@@ -824,7 +824,7 @@ Guacamole.OnScreenKeyboard.Layout = function(template) {
* numbers present will be transformed into gaps of that size, scaled
* according to the same units as each key.
*
* @type Object
* @type {Object}
*/
this.layout = template.layout;
@@ -834,7 +834,7 @@ Guacamole.OnScreenKeyboard.Layout = function(template) {
* the same units. The conversion factor between these units and pixels is
* derived later via a call to resize() on the Guacamole.OnScreenKeyboard.
*
* @type Number
* @type {Number}
*/
this.width = template.width;
@@ -844,7 +844,7 @@ Guacamole.OnScreenKeyboard.Layout = function(template) {
* overall size of the keyboard. If not defined here, the width of each
* key will default to 1.
*
* @type Object.<String, Number>
* @type {Object.<String, Number>}
*/
this.keyWidths = template.keyWidths || {};
@@ -872,7 +872,7 @@ Guacamole.OnScreenKeyboard.Key = function(template, name) {
/**
* The unique name identifying this key within the keyboard layout.
*
* @type String
* @type {String}
*/
this.name = name || template.name;
@@ -880,7 +880,7 @@ Guacamole.OnScreenKeyboard.Key = function(template, name) {
* The human-readable title that will be displayed to the user within the
* key. If not provided, this will be derived from the key name.
*
* @type String
* @type {String}
*/
this.title = template.title || this.name;
@@ -889,7 +889,7 @@ Guacamole.OnScreenKeyboard.Key = function(template, name) {
* not provided, this will be derived from the title if the title is a
* single character.
*
* @type Number
* @type {Number}
*/
this.keysym = template.keysym || (function deriveKeysym(title) {
@@ -918,7 +918,7 @@ Guacamole.OnScreenKeyboard.Key = function(template, name) {
* the "shift" modifier, for example. By default, the key will affect no
* modifiers.
*
* @type String
* @type {String}
*/
this.modifier = template.modifier;
@@ -929,7 +929,7 @@ Guacamole.OnScreenKeyboard.Key = function(template, name) {
* is named "shift" within the layout. By default, the key will require
* no modifiers.
*
* @type String[]
* @type {String[]}
*/
this.requires = template.requires || [];