mirror of
https://github.com/gyurix1968/guacamole-client.git
synced 2025-09-10 07:01:21 +00:00
GUACAMOLE-986: Update documentation of all parameters/returns to specify non-nullable and/or primitive types where appropriate.
This commit is contained in:
@@ -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;
|
||||
|
||||
|
Reference in New Issue
Block a user