Ver código fonte

Fixes some jsdocs.

master
yanas 9 anos atrás
pai
commit
d1d4674136
1 arquivos alterados com 6 adições e 3 exclusões
  1. 6
    3
      modules/UI/videolayout/SmallVideo.js

+ 6
- 3
modules/UI/videolayout/SmallVideo.js Ver arquivo

191
 /**
191
 /**
192
  * Shows / hides the audio muted indicator over small videos.
192
  * Shows / hides the audio muted indicator over small videos.
193
  *
193
  *
194
- * @param {string} isMuted indicates if the muted element should be shown
194
+ * @param {boolean} isMuted indicates if the muted element should be shown
195
  * or hidden
195
  * or hidden
196
  */
196
  */
197
 SmallVideo.prototype.showAudioIndicator = function(isMuted) {
197
 SmallVideo.prototype.showAudioIndicator = function(isMuted) {
211
  * Returns the audio muted indicator jquery object. If it doesn't exists -
211
  * Returns the audio muted indicator jquery object. If it doesn't exists -
212
  * creates it.
212
  * creates it.
213
  *
213
  *
214
- * @returns {jQuery|HTMLElement}
214
+ * @returns {jQuery|HTMLElement} the audio muted indicator
215
  */
215
  */
216
 SmallVideo.prototype.getAudioMutedIndicator = function () {
216
 SmallVideo.prototype.getAudioMutedIndicator = function () {
217
     var audioMutedSpan = $('#' + this.videoSpanId + ' .audioMuted');
217
     var audioMutedSpan = $('#' + this.videoSpanId + ' .audioMuted');
242
 /**
242
 /**
243
  * Shows video muted indicator over small videos and disables/enables avatar
243
  * Shows video muted indicator over small videos and disables/enables avatar
244
  * if video muted.
244
  * if video muted.
245
+ *
246
+ * @param {boolean} isMuted indicates if we should set the view to muted view
247
+ * or not
245
  */
248
  */
246
 SmallVideo.prototype.setMutedView = function(isMuted) {
249
 SmallVideo.prototype.setMutedView = function(isMuted) {
247
     this.isVideoMuted = isMuted;
250
     this.isVideoMuted = isMuted;
256
  * Returns the video muted indicator jquery object. If it doesn't exists -
259
  * Returns the video muted indicator jquery object. If it doesn't exists -
257
  * creates it.
260
  * creates it.
258
  *
261
  *
259
- * @returns {jQuery|HTMLElement}
262
+ * @returns {jQuery|HTMLElement} the video muted indicator
260
  */
263
  */
261
 SmallVideo.prototype.getVideoMutedIndicator = function () {
264
 SmallVideo.prototype.getVideoMutedIndicator = function () {
262
     var videoMutedSpan = $('#' + this.videoSpanId + ' .videoMuted');
265
     var videoMutedSpan = $('#' + this.videoSpanId + ' .videoMuted');

Carregando…
Cancelar
Salvar