Переглянути джерело

Fix eslint/jsdoc warnings (doc change only!)

master
Bettenbuk Zoltan 6 роки тому
джерело
коміт
3fdf944763
36 змінених файлів з 96 додано та 93 видалено
  1. 29
    26
      modules/API/external/external_api.js
  2. 6
    6
      react/features/analytics/AnalyticsEvents.js
  3. 2
    2
      react/features/app/components/AbstractApp.js
  4. 1
    1
      react/features/authentication/actions.js
  5. 2
    2
      react/features/base/conference/functions.js
  6. 1
    1
      react/features/base/connection/actions.native.js
  7. 1
    1
      react/features/base/connection/functions.js
  8. 1
    1
      react/features/base/lib-jitsi-meet/native/RTCPeerConnection.js
  9. 4
    3
      react/features/base/lib-jitsi-meet/native/polyfills-browser.js
  10. 2
    2
      react/features/base/media/components/web/Video.js
  11. 5
    5
      react/features/base/participants/components/Avatar.native.js
  12. 3
    2
      react/features/base/participants/functions.js
  13. 1
    1
      react/features/base/react/components/AbstractPage.js
  14. 2
    2
      react/features/base/react/components/NavigateSectionList.js
  15. 1
    1
      react/features/base/redux/functions.js
  16. 1
    1
      react/features/base/settings/reducer.js
  17. 1
    1
      react/features/base/storage/native/Storage.js
  18. 1
    1
      react/features/base/tracks/actions.js
  19. 1
    1
      react/features/calendar-sync/components/CalendarListContent.native.js
  20. 1
    1
      react/features/calendar-sync/components/CalendarListContent.web.js
  21. 1
    1
      react/features/calendar-sync/functions.any.js
  22. 2
    2
      react/features/conference/components/Conference.native.js
  23. 3
    3
      react/features/invite/actions.js
  24. 2
    2
      react/features/invite/middleware.native.js
  25. 2
    2
      react/features/large-video/actions.js
  26. 1
    1
      react/features/local-recording/components/LocalRecordingInfoDialog.js
  27. 2
    2
      react/features/local-recording/controller/RecordingController.js
  28. 1
    1
      react/features/local-recording/recording/flac/flacEncodeWorker.js
  29. 8
    6
      react/features/recording/actions.js
  30. 0
    1
      react/features/recording/components/LiveStream/AbstractStartLiveStreamDialog.js
  31. 2
    2
      react/features/recording/components/LiveStream/StartLiveStreamDialog.native.js
  32. 1
    1
      react/features/recording/functions.js
  33. 2
    5
      react/features/transcribing/actions.js
  34. 1
    1
      react/features/welcome/components/AbstractWelcomePage.js
  35. 1
    1
      react/features/welcome/components/WelcomePageSideBar.native.js
  36. 1
    1
      react/features/welcome/functions.js

+ 29
- 26
modules/API/external/external_api.js Переглянути файл

@@ -462,55 +462,57 @@ export default class JitsiMeetExternalAPI extends EventEmitter {
462 462
      * the event and value - the listener.
463 463
      * Currently we support the following
464 464
      * events:
465
-     * incomingMessage - receives event notifications about incoming
465
+     * {@code incomingMessage} - receives event notifications about incoming
466 466
      * messages. The listener will receive object with the following structure:
467 467
      * {{
468 468
      *  'from': from,//JID of the user that sent the message
469 469
      *  'nick': nick,//the nickname of the user that sent the message
470 470
      *  'message': txt//the text of the message
471 471
      * }}
472
-     * outgoingMessage - receives event notifications about outgoing
472
+     * {@code outgoingMessage} - receives event notifications about outgoing
473 473
      * messages. The listener will receive object with the following structure:
474 474
      * {{
475 475
      *  'message': txt//the text of the message
476 476
      * }}
477
-     * displayNameChanged - receives event notifications about display name
478
-     * change. The listener will receive object with the following structure:
477
+     * {@code displayNameChanged} - receives event notifications about display
478
+     * name change. The listener will receive object with the following
479
+     * structure:
479 480
      * {{
480 481
      * jid: jid,//the JID of the participant that changed his display name
481 482
      * displayname: displayName //the new display name
482 483
      * }}
483
-     * participantJoined - receives event notifications about new participant.
484
+     * {@code participantJoined} - receives event notifications about new
485
+     * participant.
484 486
      * The listener will receive object with the following structure:
485 487
      * {{
486 488
      * jid: jid //the jid of the participant
487 489
      * }}
488
-     * participantLeft - receives event notifications about the participant that
489
-     * left the room.
490
+     * {@code participantLeft} - receives event notifications about the
491
+     * participant that left the room.
490 492
      * The listener will receive object with the following structure:
491 493
      * {{
492 494
      * jid: jid //the jid of the participant
493 495
      * }}
494
-     * video-conference-joined - receives event notifications about the local
495
-     * user has successfully joined the video conference.
496
+     * {@code video-conference-joined} - receives event notifications about the
497
+     * local user has successfully joined the video conference.
496 498
      * The listener will receive object with the following structure:
497 499
      * {{
498 500
      * roomName: room //the room name of the conference
499 501
      * }}
500
-     * video-conference-left - receives event notifications about the local user
501
-     * has left the video conference.
502
+     * {@code video-conference-left} - receives event notifications about the
503
+     * local user has left the video conference.
502 504
      * The listener will receive object with the following structure:
503 505
      * {{
504 506
      * roomName: room //the room name of the conference
505 507
      * }}
506
-     * screenSharingStatusChanged - receives event notifications about
508
+     * {@code screenSharingStatusChanged} - receives event notifications about
507 509
      * turning on/off the local user screen sharing.
508 510
      * The listener will receive object with the following structure:
509 511
      * {{
510 512
      * on: on //whether screen sharing is on
511 513
      * }}
512
-     * readyToClose - all hangup operations are completed and Jitsi Meet is
513
-     * ready to be disposed.
514
+     * {@code readyToClose} - all hangup operations are completed and Jitsi Meet
515
+     * is ready to be disposed.
514 516
      * @returns {void}
515 517
      *
516 518
      * @deprecated
@@ -537,11 +539,12 @@ export default class JitsiMeetExternalAPI extends EventEmitter {
537 539
 
538 540
     /**
539 541
      * Executes command. The available commands are:
540
-     * displayName - sets the display name of the local participant to the value
541
-     * passed in the arguments array.
542
-     * toggleAudio - mutes / unmutes audio with no arguments.
543
-     * toggleVideo - mutes / unmutes video with no arguments.
544
-     * toggleFilmStrip - hides / shows the filmstrip with no arguments.
542
+     * {@code displayName} - Sets the display name of the local participant to
543
+     * the value passed in the arguments array.
544
+     * {@code toggleAudio} - Mutes / unmutes audio with no arguments.
545
+     * {@code toggleVideo} - Mutes / unmutes video with no arguments.
546
+     * {@code toggleFilmStrip} - Hides / shows the filmstrip with no arguments.
547
+     *
545 548
      * If the command doesn't require any arguments the parameter should be set
546 549
      * to empty array or it may be omitted.
547 550
      *
@@ -562,13 +565,13 @@ export default class JitsiMeetExternalAPI extends EventEmitter {
562 565
 
563 566
     /**
564 567
      * Executes commands. The available commands are:
565
-     * displayName - sets the display name of the local participant to the value
566
-     * passed in the arguments array.
567
-     * toggleAudio - mutes / unmutes audio. no arguments
568
-     * toggleVideo - mutes / unmutes video. no arguments
569
-     * toggleFilmStrip - hides / shows the filmstrip. no arguments
570
-     * toggleChat - hides / shows chat. no arguments.
571
-     * toggleShareScreen - starts / stops screen sharing. no arguments.
568
+     * {@code displayName} - Sets the display name of the local participant to
569
+     * the value passed in the arguments array.
570
+     * {@code toggleAudio} - Mutes / unmutes audio. No arguments.
571
+     * {@code toggleVideo} - Mutes / unmutes video. No arguments.
572
+     * {@code toggleFilmStrip} - Hides / shows the filmstrip. No arguments.
573
+     * {@code toggleChat} - Hides / shows chat. No arguments.
574
+     * {@code toggleShareScreen} - Starts / stops screen sharing. No arguments.
572 575
      *
573 576
      * @param {Object} commandList - The object with commands to be executed.
574 577
      * The keys of the object are the commands that will be executed and the

+ 6
- 6
react/features/analytics/AnalyticsEvents.js Переглянути файл

@@ -413,7 +413,7 @@ export function createRemoteVideoMenuButtonEvent(buttonName, attributes) {
413 413
 
414 414
 /**
415 415
  * Creates an event indicating that an action related to screen sharing
416
- * occurred (e.g. it was started or stopped).
416
+ * occurred (e.g. It was started or stopped).
417 417
  *
418 418
  * @param {string} action - The action which occurred.
419 419
  * @returns {Object} The event in a format suitable for sending via
@@ -466,7 +466,7 @@ export function createSharedVideoEvent(action, attributes = {}) {
466 466
  * Creates an event associated with a shortcut being pressed, released or
467 467
  * triggered. By convention, where appropriate an attribute named 'enable'
468 468
  * should be used to indicate the action which resulted by the shortcut being
469
- * pressed (e.g. whether screen sharing was enabled or disabled).
469
+ * pressed (e.g. Whether screen sharing was enabled or disabled).
470 470
  *
471 471
  * @param {string} shortcut - The identifier of the shortcut which produced
472 472
  * an action.
@@ -512,7 +512,7 @@ export function createStartAudioOnlyEvent(audioOnly) {
512 512
  *
513 513
  * @param {string} source - The source of the configuration, 'local' or
514 514
  * 'remote' depending on whether it comes from the static configuration (i.e.
515
- * config.js) or comes dynamically from Jicofo.
515
+ * {@code config.js}) or comes dynamically from Jicofo.
516 516
  * @param {boolean} audioMute - Whether the configuration requests that audio
517 517
  * is muted.
518 518
  * @param {boolean} videoMute - Whether the configuration requests that video
@@ -573,7 +573,7 @@ export function createSyncTrackStateEvent(mediaType, muted) {
573 573
  * Creates an event associated with a toolbar button being clicked/pressed. By
574 574
  * convention, where appropriate an attribute named 'enable' should be used to
575 575
  * indicate the action which resulted by the shortcut being pressed (e.g.
576
- * whether screen sharing was enabled or disabled).
576
+ * Whether screen sharing was enabled or disabled).
577 577
  *
578 578
  * @param {string} buttonName - The identifier of the toolbar button which was
579 579
  * clicked/pressed.
@@ -595,9 +595,9 @@ export function createToolbarEvent(buttonName, attributes = {}) {
595 595
  * Creates an event which indicates that a local track was muted.
596 596
  *
597 597
  * @param {string} mediaType - The track's media type ('audio' or 'video').
598
- * @param {string} reason - The reason the track was muted (e.g. it was
598
+ * @param {string} reason - The reason the track was muted (e.g. It was
599 599
  * triggered by the "initial mute" option, or a previously muted track was
600
- * replaced (e.g. when a new device was used)).
600
+ * replaced (e.g. When a new device was used)).
601 601
  * @param {boolean} muted - Whether the track was muted or unmuted.
602 602
  * @returns {Object} The event in a format suitable for sending via
603 603
  * sendAnalytics.

+ 2
- 2
react/features/app/components/AbstractApp.js Переглянути файл

@@ -128,10 +128,10 @@ export class AbstractApp extends BaseApp<Props, *> {
128 128
     }
129 129
 
130 130
     /**
131
-     * Navigates this {@code AbstractApp} to (i.e. opens) a specific URL.
131
+     * Navigates this {@code AbstractApp} to (i.e. Opens) a specific URL.
132 132
      *
133 133
      * @param {Object|string} url - The URL to navigate this {@code AbstractApp}
134
-     * to (i.e. the URL to open).
134
+     * to (i.e. The URL to open).
135 135
      * @protected
136 136
      * @returns {void}
137 137
      */

+ 1
- 1
react/features/authentication/actions.js Переглянути файл

@@ -23,7 +23,7 @@ const logger = require('jitsi-meet-logger').getLogger(__filename);
23 23
  * password + guest access configuration. Refer to {@link LoginDialog} for more
24 24
  * info.
25 25
  *
26
- * @param {string} id - The XMPP user's ID (e.g. user@domain.com).
26
+ * @param {string} id - The XMPP user's ID (e.g. {@code user@domain.com}).
27 27
  * @param {string} password - The XMPP user's password.
28 28
  * @param {JitsiConference} conference - The conference for which the local
29 29
  * participant's role will be upgraded.

+ 2
- 2
react/features/base/conference/functions.js Переглянути файл

@@ -198,8 +198,8 @@ export function getNearestReceiverVideoQualityLevel(availableHeight: number) {
198 198
 }
199 199
 
200 200
 /**
201
- * Handle an error thrown by the backend (i.e. lib-jitsi-meet) while
202
- * manipulating a conference participant (e.g. pin or select participant).
201
+ * Handle an error thrown by the backend (i.e. {@code lib-jitsi-meet}) while
202
+ * manipulating a conference participant (e.g. Pin or select participant).
203 203
  *
204 204
  * @param {Error} err - The Error which was thrown by the backend while
205 205
  * manipulating a conference participant and which is to be handled.

+ 1
- 1
react/features/base/connection/actions.native.js Переглянути файл

@@ -71,7 +71,7 @@ export type ConnectionFailedError = {
71 71
 /**
72 72
  * Opens new connection.
73 73
  *
74
- * @param {string} [id] - The XMPP user's ID (e.g. user@server.com).
74
+ * @param {string} [id] - The XMPP user's ID (e.g. {@code user@server.com}).
75 75
  * @param {string} [password] - The XMPP user's password.
76 76
  * @returns {Function}
77 77
  */

+ 1
- 1
react/features/base/connection/functions.js Переглянути файл

@@ -4,7 +4,7 @@ import { toState } from '../redux';
4 4
 
5 5
 /**
6 6
  * Retrieves a simplified version of the conference/location URL stripped of URL
7
- * params (i.e. query/search and hash) which should be used for sending invites.
7
+ * params (i.e. Query/search and hash) which should be used for sending invites.
8 8
  *
9 9
  * @param {Function|Object} stateOrGetState - The redux state or redux's
10 10
  * {@code getState} function.

+ 1
- 1
react/features/base/lib-jitsi-meet/native/RTCPeerConnection.js Переглянути файл

@@ -32,7 +32,7 @@ const SOCK_STREAM = 1; /* stream socket */
32 32
  * The RTCPeerConnection provided by react-native-webrtc fires onaddstream
33 33
  * before it remembers remotedescription (and thus makes it available to API
34 34
  * clients). Because that appears to be a problem for lib-jitsi-meet which has
35
- * been successfully running on Chrome, Firefox, etc. for a very long
35
+ * been successfully running on Chrome, Firefox and others for a very long
36 36
  * time, attempt to meet its expectations (by extending RTCPPeerConnection).
37 37
  *
38 38
  * @class

+ 4
- 3
react/features/base/lib-jitsi-meet/native/polyfills-browser.js Переглянути файл

@@ -39,9 +39,10 @@ function _getCommonPrototype(a, b) {
39 39
 }
40 40
 
41 41
 /**
42
- * Implements an absolute minimum of the common logic of Document.querySelector
43
- * and Element.querySelector. Implements the most simple of selectors necessary
44
- * to satisfy the call sites at the time of this writing i.e. select by tagName.
42
+ * Implements an absolute minimum of the common logic of
43
+ * {@code Document.querySelector} and {@code Element.querySelector}. Implements
44
+ * the most simple of selectors necessary to satisfy the call sites at the time
45
+ * of this writing (i.e. Select by tagName).
45 46
  *
46 47
  * @param {Node} node - The Node which is the root of the tree to query.
47 48
  * @param {string} selectors - The group of CSS selectors to match on.

+ 2
- 2
react/features/base/media/components/web/Video.js Переглянути файл

@@ -102,10 +102,10 @@ class Video extends Component<Props> {
102 102
     /**
103 103
      * Updates the video display only if a new track is added. This component's
104 104
      * updating is blackboxed from React to prevent re-rendering of video
105
-     * element, as the lib uses track.attach(videoElement) instead.
105
+     * element, as the lib uses {@code track.attach(videoElement)} instead.
106 106
      *
107 107
      * @inheritdoc
108
-     * @returns {boolean} - False is always returned to blackbox this component.
108
+     * @returns {boolean} - False is always returned to blackbox this component
109 109
      * from React.
110 110
      */
111 111
     shouldComponentUpdate(nextProps: Props) {

+ 5
- 5
react/features/base/participants/components/Avatar.native.js Переглянути файл

@@ -146,11 +146,11 @@ export default class Avatar extends Component<Props, State> {
146 146
     }
147 147
 
148 148
     /**
149
-     * Notifies this {@code Component} that it will be unmounted and destroyed
150
-     * and, most importantly, that it should no longer call
151
-     * {@link #setState(Object)}. {@code Avatar} needs it because it downloads
152
-     * images via {@link ImageCache} which will asynchronously notify about
153
-     * success.
149
+     * Notifies this {@code Component} that it will be unmounted and destroyed,
150
+     * and most importantly, that it should no longer call
151
+     * {@link #setState(Object)}. The {@code Avatar} needs it because it
152
+     * downloads images via {@link ImageCache} which will asynchronously notify
153
+     * about success.
154 154
      *
155 155
      * @inheritdoc
156 156
      * @returns {void}

+ 3
- 2
react/features/base/participants/functions.js Переглянути файл

@@ -127,8 +127,9 @@ export function getParticipantCount(stateful: Object | Function) {
127 127
 
128 128
 /**
129 129
  * Returns participant's display name.
130
- * FIXME: remove the hardcoded strings once interfaceConfig is stored in redux
131
- * and merge with a similarly named method in conference.js.
130
+ *
131
+ * FIXME: Remove the hardcoded strings once interfaceConfig is stored in redux
132
+ * and merge with a similarly named method in {@code conference.js}.
132 133
  *
133 134
  * @param {(Function|Object)} stateful - The (whole) redux state, or redux's
134 135
  * {@code getState} function to be used to retrieve the state.

+ 1
- 1
react/features/base/react/components/AbstractPage.js Переглянути файл

@@ -12,7 +12,7 @@ export default class AbstractPage<P> extends Component<P> {
12 12
      * content of the component.
13 13
      *
14 14
      * Note: It is a static method as the {@code Component} may not be
15
-     * initialized yet when the UI invokes refresh (e.g. tab change).
15
+     * initialized yet when the UI invokes refresh (e.g. Tab change).
16 16
      *
17 17
      * @returns {void}
18 18
      */

+ 2
- 2
react/features/base/react/components/NavigateSectionList.js Переглянути файл

@@ -91,8 +91,8 @@ class NavigateSectionList extends Component<Props> {
91 91
     }
92 92
 
93 93
     /**
94
-     * Implements React's Component.render.
95
-     * Note: we don't use the refreshing value yet, because refreshing of these
94
+     * Implements React's {@code Component.render}.
95
+     * Note: We don't use the refreshing value yet, because refreshing of these
96 96
      * lists is super quick, no need to complicate the code - yet.
97 97
      *
98 98
      * @inheritdoc

+ 1
- 1
react/features/base/redux/functions.js Переглянути файл

@@ -113,7 +113,7 @@ function _set(
113 113
 
114 114
 /**
115 115
  * Returns redux state from the specified {@code stateful} which is presumed to
116
- * be related to the redux state (e.g. the redux store, the redux
116
+ * be related to the redux state (e.g. The redux store, the redux
117 117
  * {@code getState} function).
118 118
  *
119 119
  * @param {Function|Object} stateful - The entity such as the redux store or the

+ 1
- 1
react/features/base/settings/reducer.js Переглянути файл

@@ -57,7 +57,7 @@ ReducerRegistry.register(STORE_NAME, (state = DEFAULT_STATE, action) => {
57 57
  * Retrieves the legacy profile values regardless of it's being in pre or
58 58
  * post-flattening format.
59 59
  *
60
- * FIXME: Let's remove this after a predefined time (e.g. by July 2018) to avoid
60
+ * FIXME: Let's remove this after a predefined time (e.g. By July 2018) to avoid
61 61
  * garbage in the source.
62 62
  *
63 63
  * @private

+ 1
- 1
react/features/base/storage/native/Storage.js Переглянути файл

@@ -73,7 +73,7 @@ export default class Storage {
73 73
      * Returns the value associated with a specific key in this {@code Storage}
74 74
      * in an async manner. The method is required for the cases where we need
75 75
      * the stored data but we're not sure yet whether this {@code Storage} is
76
-     * already initialized (e.g. on app start).
76
+     * already initialized (e.g. On app start).
77 77
      *
78 78
      * @param {string} key - The name of the key to retrieve the value of.
79 79
      * @returns {Promise}

+ 1
- 1
react/features/base/tracks/actions.js Переглянути файл

@@ -418,7 +418,7 @@ function _addTracks(tracks) {
418 418
  * @returns {Promise} - A {@code Promise} resolved once all
419 419
  * {@code gumProcess.cancel()} {@code Promise}s are settled because all we care
420 420
  * about here is to be sure that the {@code getUserMedia} callbacks have
421
- * completed (i.e. returned from the native side).
421
+ * completed (i.e. Returned from the native side).
422 422
  */
423 423
 function _cancelGUMProcesses(getState) {
424 424
     const logError

+ 1
- 1
react/features/calendar-sync/components/CalendarListContent.native.js Переглянути файл

@@ -115,7 +115,7 @@ class CalendarListContent extends Component<Props> {
115 115
      *
116 116
      * @private
117 117
      * @param {string} url - The url string to navigate to.
118
-     * @param {string} analyticsEventName - Тhe name of the analytics event.
118
+     * @param {string} analyticsEventName - Тhe name of the analytics event
119 119
      * associated with this action.
120 120
      * @returns {void}
121 121
      */

+ 1
- 1
react/features/calendar-sync/components/CalendarListContent.web.js Переглянути файл

@@ -121,7 +121,7 @@ class CalendarListContent extends Component<Props> {
121 121
      *
122 122
      * @private
123 123
      * @param {string} url - The url string to navigate to.
124
-     * @param {string} analyticsEventName - Тhe name of the analytics event.
124
+     * @param {string} analyticsEventName - Тhe name of the analytics event
125 125
      * associated with this action.
126 126
      * @returns {void}
127 127
      */

+ 1
- 1
react/features/calendar-sync/functions.any.js Переглянути файл

@@ -30,7 +30,7 @@ function _isDisplayableCalendarEntry(entry) {
30 30
 /**
31 31
  * Updates the calendar entries in redux when new list is received. The feature
32 32
  * calendar-sync doesn't display all calendar events, it displays unique
33
- * title, URL, and start time tuples i.e. it doesn't display subsequent
33
+ * title, URL, and start time tuples, and it doesn't display subsequent
34 34
  * occurrences of recurring events, and the repetitions of events coming from
35 35
  * multiple calendars.
36 36
  *

+ 2
- 2
react/features/conference/components/Conference.native.js Переглянути файл

@@ -433,9 +433,9 @@ function _mapDispatchToProps(dispatch) {
433 433
         /**
434 434
          * Dispatches an action changing the visibility of the {@link Toolbox}.
435 435
          *
436
-         * @param {boolean} visible - {@code true} to show the {@code Toolbox}
437
-         * or {@code false} to hide it.
438 436
          * @private
437
+         * @param {boolean} visible - Pass {@code true} to show the
438
+         * {@code Toolbox} or {@code false} to hide it.
439 439
          * @returns {void}
440 440
          */
441 441
         _setToolboxVisible(visible) {

+ 3
- 3
react/features/invite/actions.js Переглянути файл

@@ -37,14 +37,14 @@ export function beginAddPeople() {
37 37
 
38 38
 
39 39
 /**
40
- * Invites (i.e. sends invites to) an array of invitees (which may be a
41
- * combination of users, rooms, phone numbers, and video rooms).
40
+ * Invites (i.e. Sends invites to) an array of invitees (which may be a
41
+ * combination of users, rooms, phone numbers, and video rooms.
42 42
  *
43 43
  * @param  {Array<Object>} invitees - The recepients to send invites to.
44 44
  * @param  {Array<Object>} showCalleeInfo - Indicates whether the
45 45
  * {@code CalleeInfo} should be displayed or not.
46 46
  * @returns {Promise<Array<Object>>} A {@code Promise} resolving with an array
47
- * of invitees who were not invited (i.e. invites were not sent to them).
47
+ * of invitees who were not invited (i.e. Invites were not sent to them).
48 48
  */
49 49
 export function invite(
50 50
         invitees: Array<Object>,

+ 2
- 2
react/features/invite/middleware.native.js Переглянути файл

@@ -121,7 +121,7 @@ function _beginAddPeople(store, next, action) {
121 121
 }
122 122
 
123 123
 /**
124
- * Handles the {@code invite} event of the feature invite i.e. invites specific
124
+ * Handles the {@code invite} event of the feature invite and invites specific
125 125
  * invitees to the current, ongoing conference.
126 126
  *
127 127
  * @param {Object} event - The details of the event.
@@ -146,7 +146,7 @@ function _onInvite({ addPeopleControllerScope, externalAPIScope, invitees }) {
146 146
 }
147 147
 
148 148
 /**
149
- * Handles the {@code performQuery} event of the feature invite i.e. queries for
149
+ * Handles the {@code performQuery} event of the feature invite and queries for
150 150
  * invitees who may subsequently be invited to the current, ongoing conference.
151 151
  *
152 152
  * @param {Object} event - The details of the event.

+ 2
- 2
react/features/large-video/actions.js Переглянути файл

@@ -48,7 +48,7 @@ export function selectParticipant() {
48 48
 
49 49
 /**
50 50
  * Action to select the participant to be displayed in LargeVideo based on a
51
- * variety of factors: if there is a dominant or pinned speaker, or if there are
51
+ * variety of factors: If there is a dominant or pinned speaker, or if there are
52 52
  * remote tracks, etc.
53 53
  *
54 54
  * @returns {Function}
@@ -105,7 +105,7 @@ function _electLastVisibleRemoteVideo(tracks) {
105 105
 }
106 106
 
107 107
 /**
108
- * Returns the identifier of the participant who is to be on the stage i.e.
108
+ * Returns the identifier of the participant who is to be on the stage and
109 109
  * should be displayed in {@code LargeVideo}.
110 110
  *
111 111
  * @param {Object} state - The Redux state from which the participant to be

+ 1
- 1
react/features/local-recording/components/LocalRecordingInfoDialog.js Переглянути файл

@@ -288,7 +288,7 @@ class LocalRecordingInfoDialog extends Component<Props, State> {
288 288
     }
289 289
 
290 290
     /**
291
-     * Renders the moderator-only controls, i.e. stats of all users and the
291
+     * Renders the moderator-only controls: The stats of all users and the
292 292
      * action links.
293 293
      *
294 294
      * @private

+ 2
- 2
react/features/local-recording/controller/RecordingController.js Переглянути файл

@@ -221,7 +221,7 @@ class RecordingController {
221 221
     /**
222 222
      * Registers listeners for XMPP events.
223 223
      *
224
-     * @param {JitsiConference} conference - {@code JitsiConference} instance.
224
+     * @param {JitsiConference} conference - A {@code JitsiConference} instance.
225 225
      * @returns {void}
226 226
      */
227 227
     registerEvents(conference: Object) {
@@ -633,7 +633,7 @@ class RecordingController {
633 633
         }
634 634
 
635 635
         /* eslint-disable */
636
-        return (Promise.resolve(): Promise<void>); 
636
+        return (Promise.resolve(): Promise<void>);
637 637
         // FIXME: better ways to satisfy flow and ESLint at the same time?
638 638
         /* eslint-enable */
639 639
 

+ 1
- 1
react/features/local-recording/recording/flac/flacEncodeWorker.js Переглянути файл

@@ -161,7 +161,7 @@ class Encoder {
161 161
 
162 162
     /**
163 163
      * Constructor.
164
-     * Note: only create instance when Flac.isReady() returns true.
164
+     * Note: Only create instance when Flac.isReady() returns true.
165 165
      *
166 166
      * @param {number} sampleRate - Sample rate of the raw audio data.
167 167
      * @param {number} bitDepth - Bit depth (bit per sample).

+ 8
- 6
react/features/recording/actions.js Переглянути файл

@@ -31,7 +31,8 @@ export function clearRecordingSessions() {
31 31
  * Signals that the pending recording notification should be removed from the
32 32
  * screen.
33 33
  *
34
- * @param {string} streamType - The type of the stream (e.g. file or stream).
34
+ * @param {string} streamType - The type of the stream ({@code 'file'} or
35
+ * {@code 'stream'}).
35 36
  * @returns {Function}
36 37
  */
37 38
 export function hidePendingRecordingNotification(streamType: string) {
@@ -52,7 +53,6 @@ export function hidePendingRecordingNotification(streamType: string) {
52 53
  * Sets the stream key last used by the user for later reuse.
53 54
  *
54 55
  * @param {string} streamKey - The stream key to set.
55
- * redux.
56 56
  * @returns {{
57 57
  *     type: SET_STREAM_KEY,
58 58
  *     streamKey: string
@@ -69,7 +69,8 @@ export function setLiveStreamKey(streamKey: string) {
69 69
  * Signals that the pending recording notification should be shown on the
70 70
  * screen.
71 71
  *
72
- * @param {string} streamType - The type of the stream (e.g. file or stream).
72
+ * @param {string} streamType - The type of the stream ({@code file} or
73
+ * {@code stream}).
73 74
  * @returns {Function}
74 75
  */
75 76
 export function showPendingRecordingNotification(streamType: string) {
@@ -109,7 +110,8 @@ export function showRecordingError(props: Object) {
109 110
  * Signals that the stopped recording notification should be shown on the
110 111
  * screen for a given period.
111 112
  *
112
- * @param {string} streamType - The type of the stream (e.g. file or stream).
113
+ * @param {string} streamType - The type of the stream ({@code file} or
114
+ * {@code stream}).
113 115
  * @returns {showNotification}
114 116
  */
115 117
 export function showStoppedRecordingNotification(streamType: string) {
@@ -162,8 +164,8 @@ export function updateRecordingSessionData(session: Object) {
162 164
  * passed.
163 165
  *
164 166
  * @param {?number} uid - The UID of the notification.
165
- * redux.
166
- * @param {string} streamType - The type of the stream (e.g. file or stream).
167
+ * @param {string} streamType - The type of the stream ({@code file} or
168
+ * {@code stream}).
167 169
  * @returns {{
168 170
  *     type: SET_PENDING_RECORDING_NOTIFICATION_UID,
169 171
  *     streamType: string,

+ 0
- 1
react/features/recording/components/LiveStream/AbstractStartLiveStreamDialog.js Переглянути файл

@@ -194,7 +194,6 @@ export default class AbstractStartLiveStreamDialog<P: Props>
194 194
      * display of the entered YouTube stream key.
195 195
      *
196 196
      * @param {string} streamKey - The stream key entered in the field.
197
-     * changed text.
198 197
      * @private
199 198
      * @returns {void}
200 199
      */

+ 2
- 2
react/features/recording/components/LiveStream/StartLiveStreamDialog.native.js Переглянути файл

@@ -47,7 +47,7 @@ class StartLiveStreamDialog extends AbstractStartLiveStreamDialog<Props> {
47 47
      *
48 48
      * FIXME: This is a temporary method to store the streaming key on mobile
49 49
      * for easier use, until the Google sign-in is implemented. We don't store
50
-     * the key on web for security reasons (e.g. we don't want to have the key
50
+     * the key on web for security reasons (e.g. We don't want to have the key
51 51
      * stored if the used signed out).
52 52
      *
53 53
      * @private
@@ -80,7 +80,7 @@ class StartLiveStreamDialog extends AbstractStartLiveStreamDialog<Props> {
80 80
      * A callback to be invoked when an authenticated user changes, so
81 81
      * then we can get (or clear) the YouTube stream key.
82 82
      *
83
-     * TODO: handle errors by showing some indication to the user.
83
+     * TODO: Handle errors by showing some indication to the user.
84 84
      *
85 85
      * @private
86 86
      * @param {Object} response - The retreived signin response.

+ 1
- 1
react/features/recording/functions.js Переглянути файл

@@ -47,7 +47,7 @@ export function getSessionById(state: Object, id: string) {
47 47
 }
48 48
 
49 49
 /**
50
- * Returns the recording session status that is to be shown in a label. E.g. if
50
+ * Returns the recording session status that is to be shown in a label. E.g. If
51 51
  * there is a session with the status OFF and one with PENDING, then the PENDING
52 52
  * one will be shown, because that is likely more important for the user to see.
53 53
  *

+ 2
- 5
react/features/transcribing/actions.js Переглянути файл

@@ -126,11 +126,10 @@ export function showPendingTranscribingNotification() {
126 126
 
127 127
 /**
128 128
  * Sets UID of the the pending transcribing notification to use it when hiding
129
- * the notification is necessary, or unsets it when
130
- * undefined (or no param) is passed.
129
+ * the notification is necessary, or unsets it when undefined (or no param) is
130
+ * passed.
131 131
  *
132 132
  * @param {?number} uid - The UID of the notification.
133
- * redux.
134 133
  * @returns {{
135 134
  *     type: SET_PENDING_TRANSCRIBING_NOTIFICATION_UID,
136 135
  *     uid: number
@@ -185,5 +184,3 @@ export function showTranscribingError() {
185 184
         titleKey: 'transcribing.failedToStart'
186 185
     });
187 186
 }
188
-
189
-

+ 1
- 1
react/features/welcome/components/AbstractWelcomePage.js Переглянути файл

@@ -149,7 +149,7 @@ export class AbstractWelcomePage extends Component<Props, *> {
149 149
     }
150 150
 
151 151
     /**
152
-     * Determines whether the 'Join' button is (to be) disabled i.e. there's no
152
+     * Determines whether the 'Join' button is (to be) disabled i.e. There's no
153 153
      * valid room name typed into the respective text input field.
154 154
      *
155 155
      * @protected

+ 1
- 1
react/features/welcome/components/WelcomePageSideBar.native.js Переглянути файл

@@ -123,7 +123,7 @@ class WelcomePageSideBar extends Component<Props> {
123 123
     _onHideSideBar: () => void;
124 124
 
125 125
     /**
126
-     * Invoked when the sidebar has closed itself (e.g. overlay pressed).
126
+     * Invoked when the sidebar has closed itself (e.g. Overlay pressed).
127 127
      *
128 128
      * @private
129 129
      * @returns {void}

+ 1
- 1
react/features/welcome/functions.js Переглянути файл

@@ -10,7 +10,7 @@ export * from './roomnameGenerator';
10 10
 
11 11
 /**
12 12
  * Determines whether the {@code WelcomePage} is enabled by the app itself
13
- * (e.g. programmatically via the Jitsi Meet SDK for Android and iOS). Not to be
13
+ * (e.g. Programmatically via the Jitsi Meet SDK for Android and iOS). Not to be
14 14
  * confused with {@link isWelcomePageUserEnabled}.
15 15
  *
16 16
  * @param {Function|Object} stateful - The redux state or {@link getState}

Завантаження…
Відмінити
Зберегти