ソースを参照

Fixes some jsdocs.

master
yanas 9年前
コミット
d1d4674136
1個のファイルの変更6行の追加3行の削除
  1. 6
    3
      modules/UI/videolayout/SmallVideo.js

+ 6
- 3
modules/UI/videolayout/SmallVideo.js ファイルの表示

@@ -191,7 +191,7 @@ SmallVideo.prototype.hideIndicator = function () {
191 191
 /**
192 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 195
  * or hidden
196 196
  */
197 197
 SmallVideo.prototype.showAudioIndicator = function(isMuted) {
@@ -211,7 +211,7 @@ SmallVideo.prototype.showAudioIndicator = function(isMuted) {
211 211
  * Returns the audio muted indicator jquery object. If it doesn't exists -
212 212
  * creates it.
213 213
  *
214
- * @returns {jQuery|HTMLElement}
214
+ * @returns {jQuery|HTMLElement} the audio muted indicator
215 215
  */
216 216
 SmallVideo.prototype.getAudioMutedIndicator = function () {
217 217
     var audioMutedSpan = $('#' + this.videoSpanId + ' .audioMuted');
@@ -242,6 +242,9 @@ SmallVideo.prototype.getAudioMutedIndicator = function () {
242 242
 /**
243 243
  * Shows video muted indicator over small videos and disables/enables avatar
244 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 249
 SmallVideo.prototype.setMutedView = function(isMuted) {
247 250
     this.isVideoMuted = isMuted;
@@ -256,7 +259,7 @@ SmallVideo.prototype.setMutedView = function(isMuted) {
256 259
  * Returns the video muted indicator jquery object. If it doesn't exists -
257 260
  * creates it.
258 261
  *
259
- * @returns {jQuery|HTMLElement}
262
+ * @returns {jQuery|HTMLElement} the video muted indicator
260 263
  */
261 264
 SmallVideo.prototype.getVideoMutedIndicator = function () {
262 265
     var videoMutedSpan = $('#' + this.videoSpanId + ' .videoMuted');

読み込み中…
キャンセル
保存