GUACAMOLE-986: Update documentation of all parameters/returns to specify non-nullable and/or primitive types where appropriate.

This commit is contained in:
Michael Jumper
2021-12-18 19:03:52 -08:00
parent 7d92822441
commit 1ca1161a68
32 changed files with 1636 additions and 977 deletions

View File

@@ -35,7 +35,7 @@ Guacamole.JSONReader = function guacamoleJSONReader(stream) {
* Reference to this Guacamole.JSONReader.
*
* @private
* @type {Guacamole.JSONReader}
* @type {!Guacamole.JSONReader}
*/
var guacReader = this;
@@ -43,7 +43,7 @@ Guacamole.JSONReader = function guacamoleJSONReader(stream) {
* Wrapped Guacamole.StringReader.
*
* @private
* @type {Guacamole.StringReader}
* @type {!Guacamole.StringReader}
*/
var stringReader = new Guacamole.StringReader(stream);
@@ -51,14 +51,14 @@ Guacamole.JSONReader = function guacamoleJSONReader(stream) {
* All JSON read thus far.
*
* @private
* @type {String}
* @type {!string}
*/
var json = '';
/**
* Returns the current length of this Guacamole.JSONReader, in characters.
*
* @return {!Number}
* @return {!number}
* The current length of this Guacamole.JSONReader.
*/
this.getLength = function getLength() {
@@ -69,7 +69,7 @@ Guacamole.JSONReader = function guacamoleJSONReader(stream) {
* Returns the contents of this Guacamole.JSONReader as a JavaScript
* object.
*
* @return {Object}
* @return {object}
* The contents of this Guacamole.JSONReader, as parsed from the JSON
* contents of the input stream.
*/
@@ -99,7 +99,7 @@ Guacamole.JSONReader = function guacamoleJSONReader(stream) {
* Fired once for every blob of data received.
*
* @event
* @param {Number} length
* @param {!number} length
* The number of characters received.
*/
this.onprogress = null;