GUAC-791: Add missing private tags to inner variables/functions.

This commit is contained in:
Michael Jumper
2015-12-14 14:26:19 -08:00
parent 4554c64bb7
commit 7cdfd146ef
8 changed files with 89 additions and 33 deletions

View File

@@ -69,11 +69,17 @@ Guacamole.Client = function(tunnel) {
/**
* The underlying Guacamole display.
*
* @private
* @type {Guacamole.Display}
*/
var display = new Guacamole.Display();
/**
* All available layers and buffers
*
* @private
* @type {Object.<Number, (Guacamole.Display.VisibleLayer|Guacamole.Layer)>}
*/
var layers = {};
@@ -81,6 +87,7 @@ Guacamole.Client = function(tunnel) {
* All audio players currently in use by the client. Initially, this will
* be empty, but audio players may be allocated by the server upon request.
*
* @private
* @type {Object.<Number, Guacamole.AudioPlayer>}
*/
var audioPlayers = {};
@@ -89,6 +96,7 @@ Guacamole.Client = function(tunnel) {
* All video players currently in use by the client. Initially, this will
* be empty, but video players may be allocated by the server upon request.
*
* @private
* @type {Object.<Number, Guacamole.VideoPlayer>}
*/
var videoPlayers = {};
@@ -103,6 +111,7 @@ Guacamole.Client = function(tunnel) {
* All current objects. The index of each object is dictated by the
* Guacamole server.
*
* @private
* @type {Guacamole.Object[]}
*/
var objects = [];
@@ -554,11 +563,15 @@ Guacamole.Client = function(tunnel) {
* Returns the layer with the given index, creating it if necessary.
* Positive indices refer to visible layers, an index of zero refers to
* the default layer, and negative indices refer to buffers.
*
* @param {Number} index The index of the layer to retrieve.
* @return {Guacamole.Display.VisibleLayer|Guacamole.Layer} The layer having the given index.
*
* @private
* @param {Number} index
* The index of the layer to retrieve.
*
* @return {Guacamole.Display.VisibleLayer|Guacamole.Layer}
* The layer having the given index.
*/
function getLayer(index) {
var getLayer = function getLayer(index) {
// Get layer, create if necessary
var layer = layers[index];
@@ -579,7 +592,7 @@ Guacamole.Client = function(tunnel) {
return layer;
}
};
function getParser(index) {