From ec2e6525ac0db81294a9e6a7fcfe65ff114ac575 Mon Sep 17 00:00:00 2001 From: Lyubo Marinov Date: Fri, 26 May 2017 11:28:14 -0500 Subject: [PATCH] Fix jsdocs --- conference.js | 6 +-- modules/UI/UI.js | 7 ++-- react/features/base/conference/reducer.js | 2 +- .../features/base/participants/actionTypes.js | 38 +++++++++---------- 4 files changed, 25 insertions(+), 28 deletions(-) diff --git a/conference.js b/conference.js index 3e25317ff..8963cb615 100644 --- a/conference.js +++ b/conference.js @@ -1263,10 +1263,8 @@ export default { room.on( ConferenceEvents.AUTH_STATUS_CHANGED, - function (authEnabled, authLogin) { - APP.UI.updateAuthInfo(authEnabled, authLogin); - } - ); + (authEnabled, authLogin) => + APP.UI.updateAuthInfo(authEnabled, authLogin)); room.on(ConferenceEvents.PARTCIPANT_FEATURES_CHANGED, user => APP.UI.onUserFeaturesChanged(user)); diff --git a/modules/UI/UI.js b/modules/UI/UI.js index c002f0443..37e454d06 100644 --- a/modules/UI/UI.js +++ b/modules/UI/UI.js @@ -295,7 +295,7 @@ UI.getSharedVideoManager = function () { * Starts the UI module and initializes all related components. * * @returns {boolean} true if the UI is ready and the conference should be - * esablished, false - otherwise (for example in the case of welcome page) + * established, false - otherwise (for example in the case of welcome page) */ UI.start = function () { document.title = interfaceConfig.APP_NAME; @@ -367,7 +367,6 @@ UI.start = function () { // this is the default toastr close button html, just adds tabIndex "closeHtml": '' }; - } const { callee } = APP.store.getState()['features/jwt']; @@ -1385,8 +1384,8 @@ UI.hideRingOverlay /** * Indicates if any the "top" overlays are currently visible. The check includes - * the call overlay, the suspended overlay, the GUM permissions overlay, and the - * page-reload overlay. + * the call/ring overlay, the suspended overlay, the GUM permissions overlay, + * and the page-reload overlay. * * @returns {*|boolean} {true} if an overlay is visible; {false}, otherwise */ diff --git a/react/features/base/conference/reducer.js b/react/features/base/conference/reducer.js index 7ce57c842..e7614222a 100644 --- a/react/features/base/conference/reducer.js +++ b/react/features/base/conference/reducer.js @@ -89,7 +89,7 @@ function _conferenceFailed(state, action) { /** * The indicator of how the conference/room is locked. If falsy, the * conference/room is unlocked; otherwise, it's either - * {@code LOCKED_LOCALLY| or {@code LOCKED_REMOTELY}. + * {@code LOCKED_LOCALLY} or {@code LOCKED_REMOTELY}. * * @type {string} */ diff --git a/react/features/base/participants/actionTypes.js b/react/features/base/participants/actionTypes.js index ef7a23079..6a6785e2c 100644 --- a/react/features/base/participants/actionTypes.js +++ b/react/features/base/participants/actionTypes.js @@ -2,10 +2,10 @@ * Create an action for when dominant speaker changes. * * { - * type: DOMINANT_SPEAKER_CHANGED, - * participant: { - * id: string - * } + * type: DOMINANT_SPEAKER_CHANGED, + * participant: { + * id: string + * } * } */ export const DOMINANT_SPEAKER_CHANGED = Symbol('DOMINANT_SPEAKER_CHANGED'); @@ -15,9 +15,9 @@ export const DOMINANT_SPEAKER_CHANGED = Symbol('DOMINANT_SPEAKER_CHANGED'); * local participant joins a new conference or quits one. * * { - * type: PARTICIPANT_ID_CHANGED, - * newValue: string, - * oldValue: string + * type: PARTICIPANT_ID_CHANGED, + * newValue: string, + * oldValue: string * } */ export const PARTICIPANT_ID_CHANGED = Symbol('PARTICIPANT_ID_CHANGED'); @@ -26,8 +26,8 @@ export const PARTICIPANT_ID_CHANGED = Symbol('PARTICIPANT_ID_CHANGED'); * Action to signal that a participant has joined. * * { - * type: PARTICIPANT_JOINED, - * participant: Participant + * type: PARTICIPANT_JOINED, + * participant: Participant * } */ export const PARTICIPANT_JOINED = Symbol('PARTICIPANT_JOINED'); @@ -36,10 +36,10 @@ export const PARTICIPANT_JOINED = Symbol('PARTICIPANT_JOINED'); * Action to handle case when participant lefts. * * { - * type: PARTICIPANT_LEFT, - * participant: { - * id: string - * } + * type: PARTICIPANT_LEFT, + * participant: { + * id: string + * } * } */ export const PARTICIPANT_LEFT = Symbol('PARTICIPANT_LEFT'); @@ -48,8 +48,8 @@ export const PARTICIPANT_LEFT = Symbol('PARTICIPANT_LEFT'); * Action to handle case when info about participant changes. * * { - * type: PARTICIPANT_UPDATED, - * participant: Participant + * type: PARTICIPANT_UPDATED, + * participant: Participant * } */ export const PARTICIPANT_UPDATED = Symbol('PARTICIPANT_UPDATED'); @@ -58,10 +58,10 @@ export const PARTICIPANT_UPDATED = Symbol('PARTICIPANT_UPDATED'); * The type of the Redux action which pins a conference participant. * * { - * type: PIN_PARTICIPANT, - * participant: { - * id: string - * } + * type: PIN_PARTICIPANT, + * participant: { + * id: string + * } * } */ export const PIN_PARTICIPANT = Symbol('PIN_PARTICIPANT');