소스 검색

Fix jsdocs

j8
Lyubo Marinov 8 년 전
부모
커밋
ec2e6525ac
4개의 변경된 파일25개의 추가작업 그리고 28개의 파일을 삭제
  1. 2
    4
      conference.js
  2. 3
    4
      modules/UI/UI.js
  3. 1
    1
      react/features/base/conference/reducer.js
  4. 19
    19
      react/features/base/participants/actionTypes.js

+ 2
- 4
conference.js 파일 보기

@@ -1263,10 +1263,8 @@ export default {
1263 1263
 
1264 1264
         room.on(
1265 1265
             ConferenceEvents.AUTH_STATUS_CHANGED,
1266
-            function (authEnabled, authLogin) {
1267
-                APP.UI.updateAuthInfo(authEnabled, authLogin);
1268
-            }
1269
-        );
1266
+            (authEnabled, authLogin) =>
1267
+                APP.UI.updateAuthInfo(authEnabled, authLogin));
1270 1268
 
1271 1269
         room.on(ConferenceEvents.PARTCIPANT_FEATURES_CHANGED,
1272 1270
             user => APP.UI.onUserFeaturesChanged(user));

+ 3
- 4
modules/UI/UI.js 파일 보기

@@ -295,7 +295,7 @@ UI.getSharedVideoManager = function () {
295 295
  * Starts the UI module and initializes all related components.
296 296
  *
297 297
  * @returns {boolean} true if the UI is ready and the conference should be
298
- * esablished, false - otherwise (for example in the case of welcome page)
298
+ * established, false - otherwise (for example in the case of welcome page)
299 299
  */
300 300
 UI.start = function () {
301 301
     document.title = interfaceConfig.APP_NAME;
@@ -367,7 +367,6 @@ UI.start = function () {
367 367
             // this is the default toastr close button html, just adds tabIndex
368 368
             "closeHtml": '<button type="button" tabIndex="-1">&times;</button>'
369 369
         };
370
-
371 370
     }
372 371
 
373 372
     const { callee } = APP.store.getState()['features/jwt'];
@@ -1385,8 +1384,8 @@ UI.hideRingOverlay
1385 1384
 
1386 1385
 /**
1387 1386
  * Indicates if any the "top" overlays are currently visible. The check includes
1388
- * the call overlay, the suspended overlay, the GUM permissions overlay, and the
1389
- * page-reload overlay.
1387
+ * the call/ring overlay, the suspended overlay, the GUM permissions overlay,
1388
+ * and the page-reload overlay.
1390 1389
  *
1391 1390
  * @returns {*|boolean} {true} if an overlay is visible; {false}, otherwise
1392 1391
  */

+ 1
- 1
react/features/base/conference/reducer.js 파일 보기

@@ -89,7 +89,7 @@ function _conferenceFailed(state, action) {
89 89
             /**
90 90
              * The indicator of how the conference/room is locked. If falsy, the
91 91
              * conference/room is unlocked; otherwise, it's either
92
-             * {@code LOCKED_LOCALLY| or {@code LOCKED_REMOTELY}.
92
+             * {@code LOCKED_LOCALLY} or {@code LOCKED_REMOTELY}.
93 93
              *
94 94
              * @type {string}
95 95
              */

+ 19
- 19
react/features/base/participants/actionTypes.js 파일 보기

@@ -2,10 +2,10 @@
2 2
  * Create an action for when dominant speaker changes.
3 3
  *
4 4
  * {
5
- *      type: DOMINANT_SPEAKER_CHANGED,
6
- *      participant: {
7
- *          id: string
8
- *      }
5
+ *     type: DOMINANT_SPEAKER_CHANGED,
6
+ *     participant: {
7
+ *         id: string
8
+ *     }
9 9
  * }
10 10
  */
11 11
 export const DOMINANT_SPEAKER_CHANGED = Symbol('DOMINANT_SPEAKER_CHANGED');
@@ -15,9 +15,9 @@ export const DOMINANT_SPEAKER_CHANGED = Symbol('DOMINANT_SPEAKER_CHANGED');
15 15
  * local participant joins a new conference or quits one.
16 16
  *
17 17
  * {
18
- *      type: PARTICIPANT_ID_CHANGED,
19
- *      newValue: string,
20
- *      oldValue: string
18
+ *     type: PARTICIPANT_ID_CHANGED,
19
+ *     newValue: string,
20
+ *     oldValue: string
21 21
  * }
22 22
  */
23 23
 export const PARTICIPANT_ID_CHANGED = Symbol('PARTICIPANT_ID_CHANGED');
@@ -26,8 +26,8 @@ export const PARTICIPANT_ID_CHANGED = Symbol('PARTICIPANT_ID_CHANGED');
26 26
  * Action to signal that a participant has joined.
27 27
  *
28 28
  * {
29
- *      type: PARTICIPANT_JOINED,
30
- *      participant: Participant
29
+ *     type: PARTICIPANT_JOINED,
30
+ *     participant: Participant
31 31
  * }
32 32
  */
33 33
 export const PARTICIPANT_JOINED = Symbol('PARTICIPANT_JOINED');
@@ -36,10 +36,10 @@ export const PARTICIPANT_JOINED = Symbol('PARTICIPANT_JOINED');
36 36
  * Action to handle case when participant lefts.
37 37
  *
38 38
  * {
39
- *      type: PARTICIPANT_LEFT,
40
- *      participant: {
41
- *          id: string
42
- *      }
39
+ *     type: PARTICIPANT_LEFT,
40
+ *     participant: {
41
+ *         id: string
42
+ *     }
43 43
  * }
44 44
  */
45 45
 export const PARTICIPANT_LEFT = Symbol('PARTICIPANT_LEFT');
@@ -48,8 +48,8 @@ export const PARTICIPANT_LEFT = Symbol('PARTICIPANT_LEFT');
48 48
  * Action to handle case when info about participant changes.
49 49
  *
50 50
  * {
51
- *      type: PARTICIPANT_UPDATED,
52
- *      participant: Participant
51
+ *     type: PARTICIPANT_UPDATED,
52
+ *     participant: Participant
53 53
  * }
54 54
  */
55 55
 export const PARTICIPANT_UPDATED = Symbol('PARTICIPANT_UPDATED');
@@ -58,10 +58,10 @@ export const PARTICIPANT_UPDATED = Symbol('PARTICIPANT_UPDATED');
58 58
  * The type of the Redux action which pins a conference participant.
59 59
  *
60 60
  * {
61
- *      type: PIN_PARTICIPANT,
62
- *      participant: {
63
- *          id: string
64
- *      }
61
+ *     type: PIN_PARTICIPANT,
62
+ *     participant: {
63
+ *         id: string
64
+ *     }
65 65
  * }
66 66
  */
67 67
 export const PIN_PARTICIPANT = Symbol('PIN_PARTICIPANT');

Loading…
취소
저장