Fixes some jsdocs.

This commit is contained in:
yanas 2016-09-19 18:04:55 -05:00
parent 1486eac752
commit d1d4674136
1 changed files with 6 additions and 3 deletions

View File

@ -191,7 +191,7 @@ SmallVideo.prototype.hideIndicator = function () {
/** /**
* Shows / hides the audio muted indicator over small videos. * Shows / hides the audio muted indicator over small videos.
* *
* @param {string} isMuted indicates if the muted element should be shown * @param {boolean} isMuted indicates if the muted element should be shown
* or hidden * or hidden
*/ */
SmallVideo.prototype.showAudioIndicator = function(isMuted) { SmallVideo.prototype.showAudioIndicator = function(isMuted) {
@ -211,7 +211,7 @@ SmallVideo.prototype.showAudioIndicator = function(isMuted) {
* Returns the audio muted indicator jquery object. If it doesn't exists - * Returns the audio muted indicator jquery object. If it doesn't exists -
* creates it. * creates it.
* *
* @returns {jQuery|HTMLElement} * @returns {jQuery|HTMLElement} the audio muted indicator
*/ */
SmallVideo.prototype.getAudioMutedIndicator = function () { SmallVideo.prototype.getAudioMutedIndicator = function () {
var audioMutedSpan = $('#' + this.videoSpanId + ' .audioMuted'); var audioMutedSpan = $('#' + this.videoSpanId + ' .audioMuted');
@ -242,6 +242,9 @@ SmallVideo.prototype.getAudioMutedIndicator = function () {
/** /**
* Shows video muted indicator over small videos and disables/enables avatar * Shows video muted indicator over small videos and disables/enables avatar
* if video muted. * if video muted.
*
* @param {boolean} isMuted indicates if we should set the view to muted view
* or not
*/ */
SmallVideo.prototype.setMutedView = function(isMuted) { SmallVideo.prototype.setMutedView = function(isMuted) {
this.isVideoMuted = isMuted; this.isVideoMuted = isMuted;
@ -256,7 +259,7 @@ SmallVideo.prototype.setMutedView = function(isMuted) {
* Returns the video muted indicator jquery object. If it doesn't exists - * Returns the video muted indicator jquery object. If it doesn't exists -
* creates it. * creates it.
* *
* @returns {jQuery|HTMLElement} * @returns {jQuery|HTMLElement} the video muted indicator
*/ */
SmallVideo.prototype.getVideoMutedIndicator = function () { SmallVideo.prototype.getVideoMutedIndicator = function () {
var videoMutedSpan = $('#' + this.videoSpanId + ' .videoMuted'); var videoMutedSpan = $('#' + this.videoSpanId + ' .videoMuted');