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

@@ -26,21 +26,27 @@ var Guacamole = Guacamole || {};
* given Guacamole.InputStream.
*
* @constructor
* @param {Guacamole.InputStream} stream The stream that data will be read
* from.
* @param {String} mimetype The mimetype of the blob being built.
* @param {!Guacamole.InputStream} stream
* The stream that data will be read from.
*
* @param {!string} mimetype
* The mimetype of the blob being built.
*/
Guacamole.BlobReader = function(stream, mimetype) {
/**
* Reference to this Guacamole.InputStream.
*
* @private
* @type {!Guacamole.BlobReader}
*/
var guac_reader = this;
/**
* The length of this Guacamole.InputStream in bytes.
*
* @private
* @type {!number}
*/
var length = 0;
@@ -97,7 +103,9 @@ Guacamole.BlobReader = function(stream, mimetype) {
/**
* Returns the current length of this Guacamole.InputStream, in bytes.
* @return {Number} The current length of this Guacamole.InputStream.
*
* @return {!number}
* The current length of this Guacamole.InputStream.
*/
this.getLength = function() {
return length;
@@ -105,7 +113,9 @@ Guacamole.BlobReader = function(stream, mimetype) {
/**
* Returns the contents of this Guacamole.BlobReader as a Blob.
* @return {Blob} The contents of this Guacamole.BlobReader.
*
* @return {!Blob}
* The contents of this Guacamole.BlobReader.
*/
this.getBlob = function() {
return blob_builder.getBlob();
@@ -115,7 +125,8 @@ Guacamole.BlobReader = function(stream, mimetype) {
* Fired once for every blob of data received.
*
* @event
* @param {Number} length The number of bytes received.
* @param {!number} length
* The number of bytes received.
*/
this.onprogress = null;