chore(lint) tame the (uppdated) linter

This commit is contained in:
Saúl Ibarra Corretgé 2021-11-04 22:10:43 +01:00 committed by Saúl Ibarra Corretgé
parent 0aba61d5c6
commit 162a67fe8b
385 changed files with 933 additions and 900 deletions

View File

@ -13,3 +13,6 @@ load-test/*
# not seem to be a reason why we will want to risk being inconsistent with our # not seem to be a reason why we will want to risk being inconsistent with our
# remaining JavaScript source code. # remaining JavaScript source code.
!.eslintrc.js !.eslintrc.js
# Not worth it.
actionTypes.js

View File

@ -760,7 +760,7 @@ export default {
// XXX The API will take care of disconnecting from the XMPP // XXX The API will take care of disconnecting from the XMPP
// server (and, thus, leaving the room) on unload. // server (and, thus, leaving the room) on unload.
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
(new ConferenceConnector(resolve, reject)).connect(); new ConferenceConnector(resolve, reject).connect();
}); });
}, },

View File

@ -12,6 +12,6 @@ import { parseURLParams } from '../../react/features/base/util/parseURLParams';
export const API_ID = parseURLParams(window.location).jitsi_meet_external_api_id; export const API_ID = parseURLParams(window.location).jitsi_meet_external_api_id;
/** /**
* The payload name for the datachannel/endpoint text message event * The payload name for the datachannel/endpoint text message event.
*/ */
export const ENDPOINT_TEXT_MESSAGE_NAME = 'endpoint-text-message'; export const ENDPOINT_TEXT_MESSAGE_NAME = 'endpoint-text-message';

View File

@ -24,7 +24,7 @@ const ALWAYS_ON_TOP_FILENAMES = [
/** /**
* Maps the names of the commands expected by the API with the name of the * Maps the names of the commands expected by the API with the name of the
* commands expected by jitsi-meet * commands expected by jitsi-meet.
*/ */
const commands = { const commands = {
answerKnockingParticipant: 'answer-knocking-participant', answerKnockingParticipant: 'answer-knocking-participant',
@ -75,7 +75,7 @@ const commands = {
/** /**
* Maps the names of the events expected by the API with the name of the * Maps the names of the events expected by the API with the name of the
* events expected by jitsi-meet * events expected by jitsi-meet.
*/ */
const events = { const events = {
'avatar-changed': 'avatarChanged', 'avatar-changed': 'avatarChanged',
@ -129,7 +129,8 @@ const events = {
}; };
/** /**
* Last id of api object * Last id of api object.
*
* @type {number} * @type {number}
*/ */
let id = 0; let id = 0;
@ -387,7 +388,7 @@ export default class JitsiMeetExternalAPI extends EventEmitter {
} }
return ALWAYS_ON_TOP_FILENAMES.map( return ALWAYS_ON_TOP_FILENAMES.map(
filename => (new URL(filename, baseURL)).href filename => new URL(filename, baseURL).href
); );
} }

12
package-lock.json generated
View File

@ -60,7 +60,7 @@
"jquery-i18next": "1.2.1", "jquery-i18next": "1.2.1",
"js-md5": "0.6.1", "js-md5": "0.6.1",
"jwt-decode": "2.2.0", "jwt-decode": "2.2.0",
"lib-jitsi-meet": "github:jitsi/lib-jitsi-meet#e6b330186fbf667d1f8a7fa48410772cd2526e9d", "lib-jitsi-meet": "github:jitsi/lib-jitsi-meet#03bc5278dab9283b9eceee9e7b6d9b48511e3d53",
"libflacjs": "github:mmig/libflac.js#93d37e7f811f01cf7d8b6a603e38bd3c3810907d", "libflacjs": "github:mmig/libflac.js#93d37e7f811f01cf7d8b6a603e38bd3c3810907d",
"lodash": "4.17.21", "lodash": "4.17.21",
"moment": "2.29.1", "moment": "2.29.1",
@ -12405,8 +12405,8 @@
}, },
"node_modules/lib-jitsi-meet": { "node_modules/lib-jitsi-meet": {
"version": "0.0.0", "version": "0.0.0",
"resolved": "git+ssh://git@github.com/jitsi/lib-jitsi-meet.git#e6b330186fbf667d1f8a7fa48410772cd2526e9d", "resolved": "git+ssh://git@github.com/jitsi/lib-jitsi-meet.git#03bc5278dab9283b9eceee9e7b6d9b48511e3d53",
"integrity": "sha512-9dGkPk5cvhIeo9USMH9vqXk0dgbfF5rmhFFu8Zrr0I93HxmHd7hWdnwlTaOuSQc6E0q/NZTOxGn3TStNp5VN7Q==", "integrity": "sha512-PrmwypA0wTjSXswh29tnNFng505+NhLpvSNhJRa82L+bfhCCAI1c/Z2BaKFUf4FpM7s/fsU4w5yE//WZ6MpNMQ==",
"hasInstallScript": true, "hasInstallScript": true,
"license": "Apache-2.0", "license": "Apache-2.0",
"dependencies": { "dependencies": {
@ -29724,9 +29724,9 @@
} }
}, },
"lib-jitsi-meet": { "lib-jitsi-meet": {
"version": "git+ssh://git@github.com/jitsi/lib-jitsi-meet.git#e6b330186fbf667d1f8a7fa48410772cd2526e9d", "version": "git+ssh://git@github.com/jitsi/lib-jitsi-meet.git#03bc5278dab9283b9eceee9e7b6d9b48511e3d53",
"integrity": "sha512-9dGkPk5cvhIeo9USMH9vqXk0dgbfF5rmhFFu8Zrr0I93HxmHd7hWdnwlTaOuSQc6E0q/NZTOxGn3TStNp5VN7Q==", "integrity": "sha512-PrmwypA0wTjSXswh29tnNFng505+NhLpvSNhJRa82L+bfhCCAI1c/Z2BaKFUf4FpM7s/fsU4w5yE//WZ6MpNMQ==",
"from": "lib-jitsi-meet@github:jitsi/lib-jitsi-meet#e6b330186fbf667d1f8a7fa48410772cd2526e9d", "from": "lib-jitsi-meet@github:jitsi/lib-jitsi-meet#03bc5278dab9283b9eceee9e7b6d9b48511e3d53",
"requires": { "requires": {
"@jitsi/js-utils": "2.0.0", "@jitsi/js-utils": "2.0.0",
"@jitsi/sdp-interop": "github:jitsi/sdp-interop#4669790bb9020cc8f10c1d1f3823c26b08497547", "@jitsi/sdp-interop": "github:jitsi/sdp-interop#4669790bb9020cc8f10c1d1f3823c26b08497547",

View File

@ -5,5 +5,9 @@ module.exports = {
'eslint-config-jitsi/jsdoc', 'eslint-config-jitsi/jsdoc',
'eslint-config-jitsi/react', 'eslint-config-jitsi/react',
'.eslintrc-react-native.js' '.eslintrc-react-native.js'
] ],
'rules': {
// XXX remove this eventually.
'react/jsx-indent-props': 0
}
}; };

View File

@ -33,7 +33,7 @@ type State = {
* Represents the always on top page. * Represents the always on top page.
* *
* @class AlwaysOnTop * @class AlwaysOnTop
* @extends Component * @augments Component
*/ */
export default class AlwaysOnTop extends Component<*, State> { export default class AlwaysOnTop extends Component<*, State> {
_hovered: boolean; _hovered: boolean;

View File

@ -30,7 +30,7 @@ type Props = {
/** /**
* Represents the toolbar in the Always On Top window. * Represents the toolbar in the Always On Top window.
* *
* @extends Component * @augments Component
*/ */
export default class Toolbar extends Component<Props> { export default class Toolbar extends Component<Props> {
/** /**

View File

@ -2,6 +2,7 @@
* The constant for the event type 'track'. * The constant for the event type 'track'.
* TODO: keep these constants in a single place. Can we import them from * TODO: keep these constants in a single place. Can we import them from
* lib-jitsi-meet's AnalyticsEvents somehow? * lib-jitsi-meet's AnalyticsEvents somehow?
*
* @type {string} * @type {string}
*/ */
const TYPE_TRACK = 'track'; const TYPE_TRACK = 'track';
@ -10,6 +11,7 @@ const TYPE_TRACK = 'track';
* The constant for the event type 'UI' (User Interaction). * The constant for the event type 'UI' (User Interaction).
* TODO: keep these constants in a single place. Can we import them from * TODO: keep these constants in a single place. Can we import them from
* lib-jitsi-meet's AnalyticsEvents somehow? * lib-jitsi-meet's AnalyticsEvents somehow?
*
* @type {string} * @type {string}
*/ */
const TYPE_UI = 'ui'; const TYPE_UI = 'ui';

View File

@ -1,5 +1,5 @@
/** /**
* Abstract implementation of analytics handler * Abstract implementation of analytics handler.
*/ */
export default class AbstractHandler { export default class AbstractHandler {
/** /**

View File

@ -51,7 +51,7 @@ type Props = AbstractAppProps & {
/** /**
* Root app {@code Component} on mobile/React Native. * Root app {@code Component} on mobile/React Native.
* *
* @extends AbstractApp * @augments AbstractApp
*/ */
export class App extends AbstractApp { export class App extends AbstractApp {
_init: Promise<*>; _init: Promise<*>;

View File

@ -17,7 +17,7 @@ import '../reducers';
/** /**
* Root app {@code Component} on Web/React. * Root app {@code Component} on Web/React.
* *
* @extends AbstractApp * @augments AbstractApp
*/ */
export class App extends AbstractApp { export class App extends AbstractApp {
/** /**

View File

@ -29,7 +29,7 @@ type Props = {
/** /**
* Creates a ReactElement responsible for drawing audio levels. * Creates a ReactElement responsible for drawing audio levels.
* *
* @extends {Component} * @augments {Component}
*/ */
class AudioLevelIndicator extends Component<Props> { class AudioLevelIndicator extends Component<Props> {
/** /**

View File

@ -29,7 +29,7 @@ import './styles';
type Props = { type Props = {
/** /**
* {@link JitsiConference} that needs authentication - will hold a valid * {@link JitsiConference} That needs authentication - will hold a valid
* value in XMPP login + guest access mode. * value in XMPP login + guest access mode.
*/ */
_conference: Object, _conference: Object,

View File

@ -21,7 +21,7 @@ import {
type Props = { type Props = {
/** /**
* {@link JitsiConference} that needs authentication - will hold a valid * {@link JitsiConference} That needs authentication - will hold a valid
* value in XMPP login + guest access mode. * value in XMPP login + guest access mode.
*/ */
_conference: Object, _conference: Object,

View File

@ -259,5 +259,5 @@ export default class BaseApp extends Component<*, State> {
* *
* @returns {React$Element} * @returns {React$Element}
*/ */
_renderDialogContainer: () => React$Element<*> _renderDialogContainer: () => React$Element<*>;
} }

View File

@ -12,13 +12,6 @@ ReducerRegistry.register('features/base/app', (state = {}, action) => {
if (state.app !== app) { if (state.app !== app) {
return { return {
...state, ...state,
/**
* The one and only (i.e. singleton) {@link BaseApp} instance
* which is currently mounted.
*
* @type {BaseApp}
*/
app app
}; };
} }

View File

@ -38,12 +38,12 @@ export type Props = {
/** /**
* Display name of the entity to render an avatar for (if any). This is handy when we need * Display name of the entity to render an avatar for (if any). This is handy when we need
* an avatar for a non-participasnt entity (e.g. a recent list item). * an avatar for a non-participasnt entity (e.g. A recent list item).
*/ */
displayName?: string, displayName?: string,
/** /**
* Whether or not to update the background color of the avatar * Whether or not to update the background color of the avatar.
*/ */
dynamicColor?: Boolean, dynamicColor?: Boolean,

View File

@ -63,7 +63,7 @@ export default class StatelessAvatar extends AbstractStatelessAvatar<Props> {
); );
} }
_isIcon: (?string | ?Object) => boolean _isIcon: (?string | ?Object) => boolean;
/** /**
* Renders a badge representing the avatar status. * Renders a badge representing the avatar status.

View File

@ -13,7 +13,7 @@ type Props = AbstractProps & {
className?: string, className?: string,
/** /**
* The default avatar URL if we want to override the app bundled one (e.g. AlwaysOnTop) * The default avatar URL if we want to override the app bundled one (e.g. AlwaysOnTop).
*/ */
defaultAvatar?: string, defaultAvatar?: string,
@ -157,5 +157,5 @@ export default class StatelessAvatar extends AbstractStatelessAvatar<Props> {
return ''; return '';
} }
_isIcon: (?string | ?Object) => boolean _isIcon: (?string | ?Object) => boolean;
} }

View File

@ -1,5 +1,7 @@
// @flow // @flow
/* eslint-disable react/jsx-no-bind */
import React, { useState } from 'react'; import React, { useState } from 'react';
import { Icon, IconCheck, IconCopy } from '../../base/icons'; import { Icon, IconCheck, IconCopy } from '../../base/icons';
@ -9,32 +11,32 @@ import { copyText } from '../util';
type Props = { type Props = {
/** /**
* Css class to apply on container * Css class to apply on container.
*/ */
className: string, className: string,
/** /**
* The displayed text * The displayed text.
*/ */
displayedText: string, displayedText: string,
/** /**
* The text that needs to be copied (might differ from the displayedText) * The text that needs to be copied (might differ from the displayedText).
*/ */
textToCopy: string, textToCopy: string,
/** /**
* The text displayed on mouse hover * The text displayed on mouse hover.
*/ */
textOnHover: string, textOnHover: string,
/** /**
* The text displayed on copy success * The text displayed on copy success.
*/ */
textOnCopySuccess: string, textOnCopySuccess: string,
/** /**
* The id of the button * The id of the button.
*/ */
id?: string, id?: string,
}; };

View File

@ -21,7 +21,7 @@ type Props = {
children: string | React$Node, children: string | React$Node,
/** /**
* Click handler * Click handler.
*/ */
onClick: Function, onClick: Function,

View File

@ -37,12 +37,12 @@ type Props = {
isDrawerOpen: boolean, isDrawerOpen: boolean,
/** /**
* Target elements against which positioning calculations are made * Target elements against which positioning calculations are made.
*/ */
offsetTarget?: HTMLElement, offsetTarget?: HTMLElement,
/** /**
* Callback for click on an item in the menu * Callback for click on an item in the menu.
*/ */
onClick?: Function, onClick?: Function,
@ -52,12 +52,12 @@ type Props = {
onDrawerClose: Function, onDrawerClose: Function,
/** /**
* Callback for the mouse entering the component * Callback for the mouse entering the component.
*/ */
onMouseEnter?: Function, onMouseEnter?: Function,
/** /**
* Callback for the mouse leaving the component * Callback for the mouse leaving the component.
*/ */
onMouseLeave: Function onMouseLeave: Function
}; };

View File

@ -54,7 +54,7 @@ type Props = {
actions?: Array<Action>, actions?: Array<Action>,
/** /**
* The children of the component * The children of the component.
*/ */
children?: React$Node, children?: React$Node,
}; };

View File

@ -14,7 +14,7 @@ type Props = {
actions: React$Node, actions: React$Node,
/** /**
* Icon to be displayed on the list item. (Avatar for participants) * Icon to be displayed on the list item. (Avatar for participants).
*/ */
icon: React$Node, icon: React$Node,

View File

@ -1,4 +1,4 @@
/** /**
* Deploy-specific configuration whitelists * Deploy-specific configuration whitelists.
*/ */
export default []; export default [];

View File

@ -45,7 +45,7 @@ class AlertDialog extends BaseSubmitDialog<Props, *> {
); );
} }
_renderHTML: string => Object | string _renderHTML: string => Object | string;
} }
export default translate(connect(_abstractMapStateToProps)(AlertDialog)); export default translate(connect(_abstractMapStateToProps)(AlertDialog));

View File

@ -93,7 +93,7 @@ class BaseDialog<P: Props, S: State> extends AbstractDialog<P, S> {
* *
* @returns {ReactElement} * @returns {ReactElement}
*/ */
_renderContent: () => Object _renderContent: () => Object;
/** /**
* Renders a specific {@code string} which may contain HTML. * Renders a specific {@code string} which may contain HTML.

View File

@ -21,7 +21,7 @@ type Props = BaseProps & {
} }
/** /**
* Abstract dialog to submit something. E.g. a confirmation or a form. * Abstract dialog to submit something. E.g. A confirmation or a form.
*/ */
class BaseSubmitDialog<P: Props, S: *> extends BaseDialog<P, S> { class BaseSubmitDialog<P: Props, S: *> extends BaseDialog<P, S> {
/** /**
@ -84,16 +84,16 @@ class BaseSubmitDialog<P: Props, S: *> extends BaseDialog<P, S> {
_onSubmit: () => boolean; _onSubmit: () => boolean;
_renderHTML: string => Object | string _renderHTML: string => Object | string;
/** /** .
* Renders the actual content of the dialog defining what is about to be * Renders the actual content of the dialog defining what is about to be
* submitted. E.g. a simple confirmation (text, properly wrapped) or a * submitted. E.g. A simple confirmation (text, properly wrapped) or a
* complex form. * complex form.
* *
* @returns {Object} * @returns {Object}
*/ */
_renderSubmittable: () => Object _renderSubmittable: () => Object;
} }
export default BaseSubmitDialog; export default BaseSubmitDialog;

View File

@ -72,7 +72,7 @@ type Props = {
showSlidingView?: boolean, showSlidingView?: boolean,
/** /**
* The component's external style * The component's external style.
*/ */
style: Object style: Object
}; };

View File

@ -101,7 +101,7 @@ class ConfirmDialog extends BaseSubmitDialog<Props, *> {
); );
} }
_renderHTML: string => Object | string _renderHTML: string => Object | string;
} }
export default translate(connect(_abstractMapStateToProps)(ConfirmDialog)); export default translate(connect(_abstractMapStateToProps)(ConfirmDialog));

View File

@ -12,7 +12,7 @@ import AbstractDialogContainer, {
* need a separate container so we can handle multiple dialogs by showing them * need a separate container so we can handle multiple dialogs by showing them
* simultaneously or queueing them. * simultaneously or queueing them.
* *
* @extends AbstractDialogContainer * @augments AbstractDialogContainer
*/ */
class DialogContainer extends AbstractDialogContainer { class DialogContainer extends AbstractDialogContainer {

View File

@ -34,7 +34,7 @@ type Props = BaseProps & {
initialValue?: ?string, initialValue?: ?string,
/** /**
* A message key to be shown for the user (e.g. an error that is defined after submitting the form). * A message key to be shown for the user (e.g. An error that is defined after submitting the form).
*/ */
messageKey?: string, messageKey?: string,

View File

@ -27,7 +27,7 @@ export type Props = {
/** /**
* Abstract React {@code Component} for tabs of the DialogWithTabs component. * Abstract React {@code Component} for tabs of the DialogWithTabs component.
* *
* @extends Component * @augments Component
*/ */
class AbstractDialogTab<P: Props, S: *> extends Component<P, S> { class AbstractDialogTab<P: Props, S: *> extends Component<P, S> {
/** /**

View File

@ -34,7 +34,7 @@ type Props = AbstractDialogProps & {
* - 'small' (400px), 'medium' (600px), 'large' (800px), * - 'small' (400px), 'medium' (600px), 'large' (800px),
* 'x-large' (968px) * 'x-large' (968px)
* - integer value for pixel width * - integer value for pixel width
* - string value for percentage * - string value for percentage.
*/ */
width: string width: string
}; };

View File

@ -10,7 +10,7 @@ import AbstractDialogContainer, {
* Implements a DialogContainer responsible for showing all dialogs. Necessary * Implements a DialogContainer responsible for showing all dialogs. Necessary
* for supporting @atlaskit's modal animations. * for supporting @atlaskit's modal animations.
* *
* @extends AbstractDialogContainer * @augments AbstractDialogContainer
*/ */
class DialogContainer extends AbstractDialogContainer { class DialogContainer extends AbstractDialogContainer {
/** /**

View File

@ -77,7 +77,7 @@ type State = {
/** /**
* A React {@code Component} for displaying a dialog with tabs. * A React {@code Component} for displaying a dialog with tabs.
* *
* @extends Component * @augments Component
*/ */
class DialogWithTabs extends Component<Props, State> { class DialogWithTabs extends Component<Props, State> {
/** /**

View File

@ -77,11 +77,10 @@ const styles = theme => {
/** /**
* A default header for modal-dialog components * A default header for modal-dialog components.
* *
* @export
* @class ModalHeader * @class ModalHeader
* @extends {React.Component<Props>} * @augments {React.Component<Props>}
*/ */
class ModalHeader extends React.Component<Props> { class ModalHeader extends React.Component<Props> {
static defaultProps = { static defaultProps = {

View File

@ -14,12 +14,14 @@ import ModalHeader from './ModalHeader';
/** /**
* The ID to be used for the cancel button if enabled. * The ID to be used for the cancel button if enabled.
*
* @type {string} * @type {string}
*/ */
const CANCEL_BUTTON_ID = 'modal-dialog-cancel-button'; const CANCEL_BUTTON_ID = 'modal-dialog-cancel-button';
/** /**
* The ID to be used for the ok button if enabled. * The ID to be used for the ok button if enabled.
*
* @type {string} * @type {string}
*/ */
const OK_BUTTON_ID = 'modal-dialog-ok-button'; const OK_BUTTON_ID = 'modal-dialog-ok-button';
@ -102,7 +104,7 @@ type Props = DialogProps & {
* - 'small' (400px), 'medium' (600px), 'large' (800px), * - 'small' (400px), 'medium' (600px), 'large' (800px),
* 'x-large' (968px) * 'x-large' (968px)
* - integer value for pixel width * - integer value for pixel width
* - string value for percentage * - string value for percentage.
*/ */
width: string width: string
}; };
@ -131,7 +133,7 @@ class StatelessDialog extends Component<Props> {
/** /**
* The functional component to be used for rendering the modal footer. * The functional component to be used for rendering the modal footer.
*/ */
_Footer: ?Function _Footer: ?Function;
_dialogElement: ?HTMLElement; _dialogElement: ?HTMLElement;

View File

@ -1,3 +1,5 @@
// @flow
import { import {
Dialog, Dialog,
FillScreen, FillScreen,
@ -10,7 +12,11 @@ import { N0, DN50 } from '@atlaskit/theme/colors';
import { themed } from '@atlaskit/theme/components'; import { themed } from '@atlaskit/theme/components';
import React from 'react'; import React from 'react';
const ThemedDialog = props => { type Props = {
isChromeless: boolean
}
const ThemedDialog = (props: Props) => {
const style = { backgroundColor: props.isChromeless ? 'transparent' : themed({ light: N0, const style = { backgroundColor: props.isChromeless ? 'transparent' : themed({ light: N0,
dark: DN50 })({ theme: { mode: 'dark' } }) }; dark: DN50 })({ theme: { mode: 'dark' } }) };

View File

@ -52,7 +52,7 @@ export type DialogProps = {
/** /**
* The string to use as a title instead of {@code titleKey}. If a truthy * The string to use as a title instead of {@code titleKey}. If a truthy
* value is specified, it takes precedence over {@code titleKey} i.e. * value is specified, it takes precedence over {@code titleKey} i.e.
* the latter is unused. * The latter is unused.
*/ */
titleString: ?string titleString: ?string
}; };

View File

@ -9,7 +9,7 @@ export const ADD_PEOPLE_ENABLED = 'add-people.enabled';
/** /**
* Flag indicating if the SDK should not require the audio focus. * Flag indicating if the SDK should not require the audio focus.
* Used by apps that do not use Jitsi audio. * Used by apps that do not use Jitsi audio.
* Default: disabled (false) * Default: disabled (false).
*/ */
export const AUDIO_FOCUS_DISABLED = 'audio-focus.disabled'; export const AUDIO_FOCUS_DISABLED = 'audio-focus.disabled';
@ -181,13 +181,13 @@ export const RESOLUTION = 'resolution';
/** /**
* Flag indicating if the security options button should be enabled. * Flag indicating if the security options button should be enabled.
* Default: enabled (true) * Default: enabled (true).
*/ */
export const SECURITY_OPTIONS_ENABLED = 'security-options.enabled'; export const SECURITY_OPTIONS_ENABLED = 'security-options.enabled';
/** /**
* Flag indicating if server URL change is enabled. * Flag indicating if server URL change is enabled.
* Default: enabled (true) * Default: enabled (true).
*/ */
export const SERVER_URL_CHANGE_ENABLED = 'server-url-change.enabled'; export const SERVER_URL_CHANGE_ENABLED = 'server-url-change.enabled';

View File

@ -23,7 +23,7 @@ type Props = {
id?: string, id?: string,
/** /**
* Id of the icon container * Id of the icon container.
*/ */
containerId?: string, containerId?: string,
@ -48,57 +48,57 @@ type Props = {
style?: Object, style?: Object,
/** /**
* aria disabled flag for the Icon. * Aria disabled flag for the Icon.
*/ */
ariaDisabled?: boolean, ariaDisabled?: boolean,
/** /**
* aria label for the Icon. * Aria label for the Icon.
*/ */
ariaLabel?: string, ariaLabel?: string,
/** /**
* whether the element has a popup * Whether the element has a popup.
*/ */
ariaHasPopup?: boolean, ariaHasPopup?: boolean,
/** /**
* whether the element has a pressed * Whether the element has a pressed.
*/ */
ariaPressed?: boolean, ariaPressed?: boolean,
/** /**
* id of description label * Id of description label.
*/ */
ariaDescribedBy?: string, ariaDescribedBy?: string,
/** /**
* whether the element popup is expanded * Whether the element popup is expanded.
*/ */
ariaExpanded?: boolean, ariaExpanded?: boolean,
/** /**
* The id of the element this button icon controls * The id of the element this button icon controls.
*/ */
ariaControls?: string, ariaControls?: string,
/** /**
* tabIndex for the Icon. * TabIndex for the Icon.
*/ */
tabIndex?: number, tabIndex?: number,
/** /**
* role for the Icon. * Role for the Icon.
*/ */
role?: string, role?: string,
/** /**
* keypress handler. * Keypress handler.
*/ */
onKeyPress?: Function, onKeyPress?: Function,
/** /**
* keydown handler. * Keydown handler.
*/ */
onKeyDown?: Function onKeyDown?: Function
} }

View File

@ -79,9 +79,9 @@ export default class ExpandedLabel<P: Props> extends Component<P, State> {
* *
* @returns {string} * @returns {string}
*/ */
_getLabel: () => string _getLabel: () => string;
_getColor: () => string _getColor: () => string;
/** /**
* Defines the color of the expanded label. This function returns a default * Defines the color of the expanded label. This function returns a default

View File

@ -24,8 +24,8 @@ type Props = AbstractProps & {
/** /**
* Status of the label. This prop adds some additional styles based on its * Status of the label. This prop adds some additional styles based on its
* value. E.g. if status = off, it will render the label symbolising that * value. E.g. If status = off, it will render the label symbolising that
* the thing it displays (e.g. recording) is off. * the thing it displays (e.g. Recording) is off.
*/ */
status: ('in_progress' | 'off' | 'on'), status: ('in_progress' | 'off' | 'on'),

View File

@ -89,7 +89,7 @@ const styles = theme => {
/** /**
* React Component for showing short text in a circle. * React Component for showing short text in a circle.
* *
* @extends Component * @augments Component
*/ */
class Label extends AbstractLabel<Props, *> { class Label extends AbstractLabel<Props, *> {
/** /**

View File

@ -10,6 +10,7 @@ export default class JitsiMeetInMemoryLogStorage {
constructor() { constructor() {
/** /**
* Array of the log entries to keep. * Array of the log entries to keep.
*
* @type {array} * @type {array}
*/ */
this.logs = []; this.logs = [];

View File

@ -15,6 +15,7 @@ export default class JitsiMeetLogStorage {
constructor(getState) { constructor(getState) {
/** /**
* Counts each log entry, increases on every batch log entry stored. * Counts each log entry, increases on every batch log entry stored.
*
* @type {number} * @type {number}
*/ */
this.counter = 1; this.counter = 1;

View File

@ -17,7 +17,7 @@ export type AudioElement = {
}; };
/** /**
* {@code AbstractAudio} component's property types. * {@code AbstractAudio} Component's property types.
*/ */
type Props = { type Props = {

View File

@ -12,7 +12,7 @@ import styles from './styles';
/** /**
* Component that renders video element for a specified video track. * Component that renders video element for a specified video track.
* *
* @extends AbstractVideoTrack * @augments AbstractVideoTrack
*/ */
class VideoTrack extends AbstractVideoTrack<Props> { class VideoTrack extends AbstractVideoTrack<Props> {
/** /**

View File

@ -272,7 +272,7 @@ class VideoTransform extends Component<Props, State> {
}; };
} }
_didMove: Object => boolean _didMove: Object => boolean;
/** /**
* Determines if there was large enough movement to be handled. * Determines if there was large enough movement to be handled.
@ -315,7 +315,7 @@ class VideoTransform extends Component<Props, State> {
return Math.sqrt(Math.pow(dx, 2) + Math.pow(dy, 2)); return Math.sqrt(Math.pow(dx, 2) + Math.pow(dy, 2));
} }
_getTouchPosition: Object => Object _getTouchPosition: Object => Object;
/** /**
* Calculates the position of the touch event. * Calculates the position of the touch event.
@ -331,7 +331,7 @@ class VideoTransform extends Component<Props, State> {
}; };
} }
_getTransformStyle: () => Object _getTransformStyle: () => Object;
/** /**
* Generates a transform style object to be used on the component. * Generates a transform style object to be used on the component.
@ -460,7 +460,7 @@ class VideoTransform extends Component<Props, State> {
} }
} }
_onGesture: (string, ?Object | number) => void _onGesture: (string, ?Object | number) => void;
/** /**
* Handles gestures and converts them to transforms. * Handles gestures and converts them to transforms.
@ -515,7 +515,7 @@ class VideoTransform extends Component<Props, State> {
this.lastTap = 0; this.lastTap = 0;
} }
_onLayout: Object => void _onLayout: Object => void;
/** /**
* Callback for the onLayout of the component. * Callback for the onLayout of the component.
@ -535,7 +535,7 @@ class VideoTransform extends Component<Props, State> {
}); });
} }
_onMoveShouldSetPanResponder: (Object, Object) => boolean _onMoveShouldSetPanResponder: (Object, Object) => boolean;
/** /**
* Function to decide whether the responder should respond to a move event. * Function to decide whether the responder should respond to a move event.
@ -551,7 +551,7 @@ class VideoTransform extends Component<Props, State> {
|| gestureState.numberActiveTouches === 2); || gestureState.numberActiveTouches === 2);
} }
_onPanResponderGrant: (Object, Object) => void _onPanResponderGrant: (Object, Object) => void;
/** /**
* Calculates the initial touch distance. * Calculates the initial touch distance.
@ -571,7 +571,7 @@ class VideoTransform extends Component<Props, State> {
} }
} }
_onPanResponderMove: (Object, Object) => void _onPanResponderMove: (Object, Object) => void;
/** /**
* Handles the PanResponder move (touch move) event. * Handles the PanResponder move (touch move) event.
@ -615,7 +615,7 @@ class VideoTransform extends Component<Props, State> {
} }
} }
_onPanResponderRelease: () => void _onPanResponderRelease: () => void;
/** /**
* Handles the PanResponder gesture end event. * Handles the PanResponder gesture end event.
@ -631,7 +631,7 @@ class VideoTransform extends Component<Props, State> {
delete this.initialPosition; delete this.initialPosition;
} }
_onStartShouldSetPanResponder: () => boolean _onStartShouldSetPanResponder: () => boolean;
/** /**
* Function to decide whether the responder should respond to a start * Function to decide whether the responder should respond to a start

View File

@ -46,82 +46,82 @@ type Props = {
eventHandlers?: {| eventHandlers?: {|
/** /**
* onAbort event handler. * OnAbort event handler.
*/ */
onAbort?: ?Function, onAbort?: ?Function,
/** /**
* onCanPlay event handler. * OnCanPlay event handler.
*/ */
onCanPlay?: ?Function, onCanPlay?: ?Function,
/** /**
* onCanPlayThrough event handler. * OnCanPlayThrough event handler.
*/ */
onCanPlayThrough?: ?Function, onCanPlayThrough?: ?Function,
/** /**
* onEmptied event handler. * OnEmptied event handler.
*/ */
onEmptied?: ?Function, onEmptied?: ?Function,
/** /**
* onEnded event handler. * OnEnded event handler.
*/ */
onEnded?: ?Function, onEnded?: ?Function,
/** /**
* onError event handler. * OnError event handler.
*/ */
onError?: ?Function, onError?: ?Function,
/** /**
* onLoadedData event handler. * OnLoadedData event handler.
*/ */
onLoadedData?: ?Function, onLoadedData?: ?Function,
/** /**
* onLoadedMetadata event handler. * OnLoadedMetadata event handler.
*/ */
onLoadedMetadata?: ?Function, onLoadedMetadata?: ?Function,
/** /**
* onLoadStart event handler. * OnLoadStart event handler.
*/ */
onLoadStart?: ?Function, onLoadStart?: ?Function,
/** /**
* onPause event handler. * OnPause event handler.
*/ */
onPause?: ?Function, onPause?: ?Function,
/** /**
* onPlay event handler. * OnPlay event handler.
*/ */
onPlay?: ?Function, onPlay?: ?Function,
/** /**
* onPlaying event handler. * OnPlaying event handler.
*/ */
onPlaying?: ?Function, onPlaying?: ?Function,
/** /**
* onRateChange event handler. * OnRateChange event handler.
*/ */
onRateChange?: ?Function, onRateChange?: ?Function,
/** /**
* onStalled event handler. * OnStalled event handler.
*/ */
onStalled?: ?Function, onStalled?: ?Function,
/** /**
* onSuspend event handler. * OnSuspend event handler.
*/ */
onSuspend?: ?Function, onSuspend?: ?Function,
/** /**
* onWaiting event handler. * OnWaiting event handler.
*/ */
onWaiting?: ?Function onWaiting?: ?Function
|}, |},
@ -140,7 +140,7 @@ type Props = {
/** /**
* Component that renders a video element for a passed in video track. * Component that renders a video element for a passed in video track.
* *
* @extends Component * @augments Component
*/ */
class Video extends Component<Props> { class Video extends Component<Props> {
_videoElement: ?Object; _videoElement: ?Object;

View File

@ -37,82 +37,82 @@ type Props = AbstractVideoTrackProps & {
eventHandlers?: {| eventHandlers?: {|
/** /**
* onAbort event handler. * OnAbort event handler.
*/ */
onAbort?: ?Function, onAbort?: ?Function,
/** /**
* onCanPlay event handler. * OnCanPlay event handler.
*/ */
onCanPlay?: ?Function, onCanPlay?: ?Function,
/** /**
* onCanPlayThrough event handler. * OnCanPlayThrough event handler.
*/ */
onCanPlayThrough?: ?Function, onCanPlayThrough?: ?Function,
/** /**
* onEmptied event handler. * OnEmptied event handler.
*/ */
onEmptied?: ?Function, onEmptied?: ?Function,
/** /**
* onEnded event handler. * OnEnded event handler.
*/ */
onEnded?: ?Function, onEnded?: ?Function,
/** /**
* onError event handler. * OnError event handler.
*/ */
onError?: ?Function, onError?: ?Function,
/** /**
* onLoadedData event handler. * OnLoadedData event handler.
*/ */
onLoadedData?: ?Function, onLoadedData?: ?Function,
/** /**
* onLoadedMetadata event handler. * OnLoadedMetadata event handler.
*/ */
onLoadedMetadata?: ?Function, onLoadedMetadata?: ?Function,
/** /**
* onLoadStart event handler. * OnLoadStart event handler.
*/ */
onLoadStart?: ?Function, onLoadStart?: ?Function,
/** /**
* onPause event handler. * OnPause event handler.
*/ */
onPause?: ?Function, onPause?: ?Function,
/** /**
* onPlay event handler. * OnPlay event handler.
*/ */
onPlay?: ?Function, onPlay?: ?Function,
/** /**
* onPlaying event handler. * OnPlaying event handler.
*/ */
onPlaying?: ?Function, onPlaying?: ?Function,
/** /**
* onRateChange event handler. * OnRateChange event handler.
*/ */
onRateChange?: ?Function, onRateChange?: ?Function,
/** /**
* onStalled event handler. * OnStalled event handler.
*/ */
onStalled?: ?Function, onStalled?: ?Function,
/** /**
* onSuspend event handler. * OnSuspend event handler.
*/ */
onSuspend?: ?Function, onSuspend?: ?Function,
/** /**
* onWaiting event handler. * OnWaiting event handler.
*/ */
onWaiting?: ?Function, onWaiting?: ?Function,
|}, |},
@ -132,7 +132,7 @@ type Props = AbstractVideoTrackProps & {
* Component that renders a video element for a passed in video track and * Component that renders a video element for a passed in video track and
* notifies the store when the video has started playing. * notifies the store when the video has started playing.
* *
* @extends AbstractVideoTrack * @augments AbstractVideoTrack
*/ */
class VideoTrack extends AbstractVideoTrack<Props> { class VideoTrack extends AbstractVideoTrack<Props> {
/** /**

View File

@ -106,7 +106,7 @@ type Props = {
* The test hint id which can be used to locate the {@code ParticipantView} * The test hint id which can be used to locate the {@code ParticipantView}
* on the jitsi-meet-torture side. If not provided, the * on the jitsi-meet-torture side. If not provided, the
* {@code participantId} with the following format will be used: * {@code participantId} with the following format will be used:
* {@code `org.jitsi.meet.Participant#${participantId}`} * {@code `org.jitsi.meet.Participant#${participantId}`}.
*/ */
testHintId: ?string, testHintId: ?string,
@ -133,7 +133,7 @@ type Props = {
* Implements a React Component which depicts a specific participant's avatar * Implements a React Component which depicts a specific participant's avatar
* and video. * and video.
* *
* @extends Component * @augments Component
*/ */
class ParticipantView extends Component<Props> { class ParticipantView extends Component<Props> {

View File

@ -37,7 +37,7 @@ export default {
}, },
/** /**
* {@code ParticipantView} style. * {@code ParticipantView} Style.
*/ */
participantView: { participantView: {
alignItems: 'stretch', alignItems: 'stretch',

View File

@ -47,6 +47,7 @@ export const MAX_DISPLAY_NAME_LENGTH = 50;
/** /**
* The identifier of the sound to be played when new remote participant joins * The identifier of the sound to be played when new remote participant joins
* the room. * the room.
*
* @type {string} * @type {string}
*/ */
export const PARTICIPANT_JOINED_SOUND_ID = 'PARTICIPANT_JOINED_SOUND'; export const PARTICIPANT_JOINED_SOUND_ID = 'PARTICIPANT_JOINED_SOUND';
@ -54,6 +55,7 @@ export const PARTICIPANT_JOINED_SOUND_ID = 'PARTICIPANT_JOINED_SOUND';
/** /**
* The identifier of the sound to be played when remote participant leaves * The identifier of the sound to be played when remote participant leaves
* the room. * the room.
*
* @type {string} * @type {string}
*/ */
export const PARTICIPANT_LEFT_SOUND_ID = 'PARTICIPANT_LEFT_SOUND'; export const PARTICIPANT_LEFT_SOUND_ID = 'PARTICIPANT_LEFT_SOUND';

View File

@ -20,6 +20,7 @@ declare var interfaceConfig: Object;
/** /**
* Participant object. * Participant object.
*
* @typedef {Object} Participant * @typedef {Object} Participant
* @property {string} id - Participant ID. * @property {string} id - Participant ID.
* @property {string} name - Participant name. * @property {string} name - Participant name.

View File

@ -86,7 +86,7 @@ type State = {
* Implements a React {@code Component} for showing an {@code InlineDialog} on * Implements a React {@code Component} for showing an {@code InlineDialog} on
* mouseenter of the trigger and contents, and hiding the dialog on mouseleave. * mouseenter of the trigger and contents, and hiding the dialog on mouseleave.
* *
* @extends Component * @augments Component
*/ */
class Popover extends Component<Props, State> { class Popover extends Component<Props, State> {
/** /**

View File

@ -53,27 +53,27 @@ type Props = {
onOptionsClick?: Function, onOptionsClick?: Function,
/** /**
* to navigate with the keyboard. * To navigate with the keyboard.
*/ */
tabIndex?: number, tabIndex?: number,
/** /**
* to give a role to the icon. * To give a role to the icon.
*/ */
role?: string, role?: string,
/** /**
* to give a aria-pressed to the icon. * To give a aria-pressed to the icon.
*/ */
ariaPressed?: boolean, ariaPressed?: boolean,
/** /**
* The Label of the current element * The Label of the current element.
*/ */
ariaLabel?: string, ariaLabel?: string,
/** /**
* The Label of the child element * The Label of the child element.
*/ */
ariaDropDownLabel?: string ariaDropDownLabel?: string
}; };

View File

@ -42,7 +42,7 @@ type Props = {
readOnly?: boolean, readOnly?: boolean,
/** /**
* The field type (e.g. text, password...etc). * The field type (e.g. Text, password...etc).
*/ */
type: string, type: string,

View File

@ -38,12 +38,12 @@ type Props = {
name?: string, name?: string,
/** /**
* Indicates whether the copy url button should be shown * Indicates whether the copy url button should be shown.
*/ */
showCopyUrlButton: boolean, showCopyUrlButton: boolean,
/** /**
* Indicates whether the device status should be shown * Indicates whether the device status should be shown.
*/ */
showDeviceStatus: boolean, showDeviceStatus: boolean,

View File

@ -12,7 +12,7 @@ import { getLocalVideoTrack } from '../../../tracks';
export type Props = { export type Props = {
/** /**
* Local participant id * Local participant id.
*/ */
_participantId: string, _participantId: string,

View File

@ -115,10 +115,8 @@ function _getLevel(thresholds, value, descending = true) {
/** /**
* Returns the connection details from the test results. * Returns the connection details from the test results.
* *
* @param {{ * @param {number} testResults.fractionalLoss - Factional loss.
* fractionalLoss: number, * @param {number} testResults.throughput - Throughput.
* throughput: number
* }} testResults - The state of the app.
* *
* @returns {{ * @returns {{
* connectionType: string, * connectionType: string,

View File

@ -13,7 +13,7 @@ export type Item = {
avatar: ?string, avatar: ?string,
/** /**
* the color base of the avatar * The color base of the avatar.
*/ */
colorBase: string, colorBase: string,
@ -28,46 +28,46 @@ export type Item = {
id: Object | string, id: Object | string,
/** /**
* Item title * Item title.
*/ */
title: string, title: string,
/** /**
* Item url * Item url.
*/ */
url: string, url: string,
/** /**
* lines[0] - date * Lines[0] - date
* lines[1] - duration * lines[1] - duration
* lines[2] - server name * lines[2] - server name.
*/ */
lines: Array<string> lines: Array<string>
} }
/** /**
* web implementation of section data for NavigateSectionList * Web implementation of section data for NavigateSectionList.
*/ */
export type Section = { export type Section = {
/** /**
* section title * Section title.
*/ */
title: string, title: string,
/** /**
* unique key for the section * Unique key for the section.
*/ */
key?: string, key?: string,
/** /**
* Array of items in the section * Array of items in the section.
*/ */
data: $ReadOnlyArray<Item>, data: $ReadOnlyArray<Item>,
/** /**
* Optional properties added only to fix some flow errors thrown by React * Optional properties added only to fix some flow errors thrown by React
* SectionList * SectionList.
*/ */
ItemSeparatorComponent?: ?ComponentType<any>, ItemSeparatorComponent?: ?ComponentType<any>,
@ -78,12 +78,12 @@ export type Section = {
} }
/** /**
* native implementation of section data for NavigateSectionList * Native implementation of section data for NavigateSectionList.
* *
* When react-native's SectionList component parses through an array of sections * When react-native's SectionList component parses through an array of sections
* it passes the section nested within the section property of another object * it passes the section nested within the section property of another object
* to the renderSection method (on web for our own implementation of SectionList * to the renderSection method (on web for our own implementation of SectionList
* this nesting is not implemented as there is no need for nesting) * this nesting is not implemented as there is no need for nesting).
*/ */
export type SetionListSection = { export type SetionListSection = {
section: Section section: Section

View File

@ -5,7 +5,7 @@ import React, { Component } from 'react';
import { getFixedPlatformStyle } from '../../styles'; import { getFixedPlatformStyle } from '../../styles';
/** /**
* {@code AbstractContainer} component's property types. * {@code AbstractContainer} Component's property types.
*/ */
export type Props = { export type Props = {
@ -69,7 +69,7 @@ export type Props = {
* Abstract (base) class for container of React {@link Component} children with * Abstract (base) class for container of React {@link Component} children with
* a style. * a style.
* *
* @extends Component * @augments Component
*/ */
export default class AbstractContainer<P: Props> extends Component<P> { export default class AbstractContainer<P: Props> extends Component<P> {
/** /**

View File

@ -47,7 +47,7 @@ type Props = {
renderListEmptyComponent: Function, renderListEmptyComponent: Function,
/** /**
* An array of sections * An array of sections.
*/ */
sections: Array<Section> sections: Array<Section>
}; };

View File

@ -43,7 +43,7 @@ type Props = {
children?: React$Node, children?: React$Node,
/** /**
* item containing data to be rendered * Item containing data to be rendered.
*/ */
item: Item, item: Item,

View File

@ -8,7 +8,7 @@ import { Icon, IconArrowBack } from '../../../icons';
import { connect } from '../../../redux'; import { connect } from '../../../redux';
/** /**
* The type of the React {@code Component} props of {@link BackButton} * The type of the React {@code Component} props of {@link BackButton}.
*/ */
type Props = { type Props = {

View File

@ -16,7 +16,7 @@ type Props = {
onValueChange: Function, onValueChange: Function,
/** /**
* The component's external style * The component's external style.
*/ */
style: Object style: Object
}; };

View File

@ -22,7 +22,7 @@ type Props = AbstractProps & {
/** /**
* Represents a container of React Native/mobile {@link Component} children. * Represents a container of React Native/mobile {@link Component} children.
* *
* @extends AbstractContainer * @augments AbstractContainer
*/ */
export default class Container<P: Props> extends AbstractContainer<P> { export default class Container<P: Props> extends AbstractContainer<P> {
/** /**

View File

@ -8,7 +8,7 @@ import { translate } from '../../../i18n';
import { connect } from '../../../redux'; import { connect } from '../../../redux';
/** /**
* The type of the React {@code Component} props of {@link ForwardButton} * The type of the React {@code Component} props of {@link ForwardButton}.
*/ */
type Props = { type Props = {

View File

@ -17,7 +17,7 @@ const STATUSBAR_DARK = 'dark-content';
const STATUSBAR_LIGHT = 'light-content'; const STATUSBAR_LIGHT = 'light-content';
/** /**
* The type of the React {@code Component} props of {@link Header} * The type of the React {@code Component} props of {@link Header}.
*/ */
type Props = { type Props = {
@ -27,7 +27,7 @@ type Props = {
children: Node, children: Node,
/** /**
* The component's external style * The component's external style.
*/ */
style: Object, style: Object,

View File

@ -8,7 +8,7 @@ import { translate } from '../../../i18n';
import { connect } from '../../../redux'; import { connect } from '../../../redux';
/** /**
* The type of the React {@code Component} props of {@link HeaderLabel} * The type of the React {@code Component} props of {@link HeaderLabel}.
*/ */
type Props = { type Props = {

View File

@ -23,7 +23,7 @@ type Props = {
forwardLabelKey: ?string, forwardLabelKey: ?string,
/** /**
* The i18n key of the header label (title) * The i18n key of the header label (title).
*/ */
headerLabelKey: ?string, headerLabelKey: ?string,

View File

@ -14,7 +14,7 @@ type Props = {
src: Object, src: Object,
/** /**
* The component's external style * The component's external style.
*/ */
style: Object style: Object
}; };
@ -22,7 +22,7 @@ type Props = {
/** /**
* A component rendering aN IMAGE. * A component rendering aN IMAGE.
* *
* @extends Component * @augments Component
*/ */
export default class ImageImpl extends Component<Props> { export default class ImageImpl extends Component<Props> {
/** /**

View File

@ -19,7 +19,7 @@ type Props = {
* be an unnecessary duplication and probably an unmaintained list after a * be an unnecessary duplication and probably an unmaintained list after a
* while. * while.
* *
* See list: https://facebook.github.io/react-native/docs/modal * See list: https://facebook.github.io/react-native/docs/modal.
*/ */
}; };

View File

@ -18,9 +18,9 @@ type Props = {
/** /**
* Implements a React Native {@link Component} that is to be displayed when the * Implements a React Native {@link Component} that is to be displayed when the
* list is empty * list is empty.
* *
* @extends Component * @augments Component
*/ */
class NavigateSectionListEmptyComponent extends Component<Props> { class NavigateSectionListEmptyComponent extends Component<Props> {
/** /**

View File

@ -12,7 +12,7 @@ import styles from './styles';
type Props = { type Props = {
/** /**
* item containing data to be rendered * Item containing data to be rendered.
*/ */
item: Item, item: Item,
@ -34,9 +34,9 @@ type Props = {
/** /**
* Implements a React/Native {@link Component} that renders the Navigate Section * Implements a React/Native {@link Component} that renders the Navigate Section
* List Item * List Item.
* *
* @extends Component * @augments Component
*/ */
export default class NavigateSectionListItem extends Component<Props> { export default class NavigateSectionListItem extends Component<Props> {
/** /**

View File

@ -11,16 +11,16 @@ import styles from './styles';
type Props = { type Props = {
/** /**
* A section containing the data to be rendered * A section containing the data to be rendered.
*/ */
section: SetionListSection section: SetionListSection
} }
/** /**
* Implements a React/Native {@link Component} that renders the section header * Implements a React/Native {@link Component} that renders the section header
* of the list * of the list.
* *
* @extends Component * @augments Component
*/ */
export default class NavigateSectionListSectionHeader extends Component<Props> { export default class NavigateSectionListSectionHeader extends Component<Props> {
/** /**

View File

@ -63,7 +63,7 @@ type State = {
/** /**
* A component that renders a paged list. * A component that renders a paged list.
* *
* @extends PagedList * @augments PagedList
*/ */
class PagedList extends Component<Props, State> { class PagedList extends Component<Props, State> {

View File

@ -10,7 +10,7 @@ type Props = {
children: React$Node, children: React$Node,
/** /**
* Called when the touch is released, but not if cancelled (e.g. by a scroll * Called when the touch is released, but not if cancelled (e.g. By a scroll
* that steals the responder lock). * that steals the responder lock).
*/ */
onPress: Function onPress: Function

View File

@ -11,7 +11,7 @@ import type { Section } from '../../Types';
import styles from './styles'; import styles from './styles';
/** /**
* The type of the React {@code Component} props of {@link SectionList} * The type of the React {@code Component} props of {@link SectionList}.
*/ */
type Props = { type Props = {
@ -30,7 +30,7 @@ type Props = {
/** /**
* *
* Functions that defines what happens when the list is pulled for refresh * Functions that defines what happens when the list is pulled for refresh.
*/ */
onRefresh: Function, onRefresh: Function,
@ -54,7 +54,7 @@ type Props = {
renderSectionHeader: Object, renderSectionHeader: Object,
/** /**
* An array of sections * An array of sections.
*/ */
sections: Array<Section> sections: Array<Section>
}; };
@ -62,9 +62,9 @@ type Props = {
/** /**
* Implements a React Native {@link Component} that wraps the React Native * Implements a React Native {@link Component} that wraps the React Native
* SectionList component in a SafeAreaView so that it renders the sectionlist * SectionList component in a SafeAreaView so that it renders the sectionlist
* within the safe area of the device * within the safe area of the device.
* *
* @extends Component * @augments Component
*/ */
export default class SectionList extends Component<Props> { export default class SectionList extends Component<Props> {
/** /**

View File

@ -31,7 +31,7 @@ type Props = {
/** /**
* Position of the SlidingView: 'left', 'right', 'top', 'bottom'. * Position of the SlidingView: 'left', 'right', 'top', 'bottom'.
* later). * Later).
*/ */
position: string, position: string,

View File

@ -19,7 +19,7 @@ ColorSchemeRegistry.register('Header', {
}, },
/** /**
* Platform specific header button (e.g. back, menu, etc). * Platform specific header button (e.g. Back, menu, etc).
*/ */
headerButtonIcon: { headerButtonIcon: {
alignSelf: 'center', alignSelf: 'center',

View File

@ -62,7 +62,7 @@ type Props = {
/** /**
* React {@code Component} for showing an icon with a tooltip. * React {@code Component} for showing an icon with a tooltip.
* *
* @extends Component * @augments Component
*/ */
class BaseIndicator extends Component<Props> { class BaseIndicator extends Component<Props> {
/** /**

View File

@ -6,7 +6,7 @@ import type { Props } from '../AbstractContainer';
/** /**
* Represents a container of React/Web {@link Component} children with a style. * Represents a container of React/Web {@link Component} children with a style.
* *
* @extends AbstractContainer * @augments AbstractContainer
*/ */
export default class Container<P: Props> extends AbstractContainer<P> { export default class Container<P: Props> extends AbstractContainer<P> {
/** /**

View File

@ -4,7 +4,7 @@ import React, { Component } from 'react';
* Implements a React/Web {@link Component} for displaying image * Implements a React/Web {@link Component} for displaying image
* in order to facilitate cross-platform source code. * in order to facilitate cross-platform source code.
* *
* @extends Component * @augments Component
*/ */
export default class Image extends Component { export default class Image extends Component {
/** /**

View File

@ -23,7 +23,7 @@ type Props = {
t: Function, t: Function,
/** /**
* Indicates whether the support link should be shown in case of an error * Indicates whether the support link should be shown in case of an error.
*/ */
showSupportLink: Boolean, showSupportLink: Boolean,
}; };

View File

@ -84,7 +84,7 @@ function _toTimeString(times) {
* Implements a React/Web {@link Component} for displaying a list with * Implements a React/Web {@link Component} for displaying a list with
* meetings. * meetings.
* *
* @extends Component * @augments Component
*/ */
class MeetingsList extends Component<Props> { class MeetingsList extends Component<Props> {
/** /**
@ -108,7 +108,7 @@ class MeetingsList extends Component<Props> {
const { listEmptyComponent, meetings, t } = this.props; const { listEmptyComponent, meetings, t } = this.props;
/** /**
* If there are no recent meetings we don't want to display anything * If there are no recent meetings we don't want to display anything.
*/ */
if (meetings) { if (meetings) {
return ( return (

View File

@ -22,7 +22,7 @@ type Props = {
/** /**
* Optional footer to show as a last element in the results. * Optional footer to show as a last element in the results.
* Should be of type {content: <some content>} * Should be of type {content: <some content>}.
*/ */
footer: Object, footer: Object,
@ -73,7 +73,7 @@ type Props = {
shouldFocus: boolean, shouldFocus: boolean,
/** /**
* Indicates whether the support link should be shown in case of an error * Indicates whether the support link should be shown in case of an error.
*/ */
showSupportLink: Boolean, showSupportLink: Boolean,
}; };

View File

@ -19,16 +19,16 @@ type Props = {
onPress: ?Function, onPress: ?Function,
/** /**
* A item containing data to be rendered * A item containing data to be rendered.
*/ */
item: Item item: Item
}; };
/** /**
* Implements a React/Web {@link Component} for displaying an item in a * Implements a React/Web {@link Component} for displaying an item in a
* NavigateSectionList * NavigateSectionList.
* *
* @extends Component * @augments Component
*/ */
export default class NavigateSectionListItem<P: Props> export default class NavigateSectionListItem<P: Props>
extends Component<P> { extends Component<P> {
@ -46,7 +46,8 @@ export default class NavigateSectionListItem<P: Props>
* Initializes the date and duration of the conference to the an empty * Initializes the date and duration of the conference to the an empty
* string in case for some reason there is an error where the item data * string in case for some reason there is an error where the item data
* lines doesn't contain one or both of those values (even though this * lines doesn't contain one or both of those values (even though this
* unlikely the app shouldn't break because of it) * unlikely the app shouldn't break because of it).
*
* @type {string} * @type {string}
*/ */
let date = ''; let date = '';

View File

@ -9,16 +9,16 @@ import Text from './Text';
type Props = { type Props = {
/** /**
* A section containing the data to be rendered * A section containing the data to be rendered.
*/ */
section: Section section: Section
} }
/** /**
* Implements a React/Web {@link Component} that renders the section header of * Implements a React/Web {@link Component} that renders the section header of
* the list * the list.
* *
* @extends Component * @augments Component
*/ */
export default class NavigateSectionListSectionHeader extends Component<Props> { export default class NavigateSectionListSectionHeader extends Component<Props> {
/** /**

View File

@ -20,22 +20,22 @@ type Props = {
keyExtractor: Function, keyExtractor: Function,
/** /**
* Returns a React component that renders each Item in the list * Returns a React component that renders each Item in the list.
*/ */
renderItem: Function, renderItem: Function,
/** /**
* Returns a React component that renders the header for every section * Returns a React component that renders the header for every section.
*/ */
renderSectionHeader: Function, renderSectionHeader: Function,
/** /**
* An array of sections * An array of sections.
*/ */
sections: Array<Section>, sections: Array<Section>,
/** /**
* defines what happens when an item in the section list is clicked * Defines what happens when an item in the section list is clicked.
*/ */
onItemClick: Function onItemClick: Function
}; };
@ -45,7 +45,7 @@ type Props = {
* sections similar to React Native's {@code SectionList} in order to * sections similar to React Native's {@code SectionList} in order to
* facilitate cross-platform source code. * facilitate cross-platform source code.
* *
* @extends Component * @augments Component
*/ */
export default class SectionList extends Component<Props> { export default class SectionList extends Component<Props> {
/** /**
@ -63,7 +63,7 @@ export default class SectionList extends Component<Props> {
} = this.props; } = this.props;
/** /**
* If there are no recent items we don't want to display anything * If there are no recent items we don't want to display anything.
*/ */
if (sections) { if (sections) {
return ( return (

View File

@ -6,7 +6,7 @@ import React, { Component } from 'react';
type Props = { type Props = {
/** /**
* ID of the toggle * ID of the toggle.
*/ */
id: string, id: string,

View File

@ -4,7 +4,7 @@ import React, { Component } from 'react';
* Implements a React/Web {@link Component} for displaying text similar to React * Implements a React/Web {@link Component} for displaying text similar to React
* Native's {@code Text} in order to facilitate cross-platform source code. * Native's {@code Text} in order to facilitate cross-platform source code.
* *
* @extends Component * @augments Component
*/ */
export default class Text extends Component { export default class Text extends Component {
/** /**

View File

@ -44,7 +44,7 @@ type Selector = (state: Object, prevSelection: any) => any;
type RegistrationOptions = { type RegistrationOptions = {
/** /**
* @property {boolean} [deepEquals=false] - whether or not a deep equals check should be performed on the selection * @property {boolean} [deepEquals=false] - Whether or not a deep equals check should be performed on the selection
* returned by {@link Selector}. * returned by {@link Selector}.
*/ */
deepEquals: ?boolean deepEquals: ?boolean

View File

@ -10,17 +10,15 @@ import { DEFAULT_SERVER_URL } from './constants';
* a precedence among the values specified by JWT, URL, settings, * a precedence among the values specified by JWT, URL, settings,
* and config. * and config.
* *
* @param {Object|Function} stateful - The redux state object or * @param {Object|Function} stateful - The redux state object or {@code getState} function.
* {@code getState} function.
* @param {string} propertyName - The name of the * @param {string} propertyName - The name of the
* configuration/preference/setting (property) to retrieve. * configuration/preference/setting (property) to retrieve.
* @param {{ * @param {Object} sources - Flags indicating the configuration/preference/setting sources to
* config: boolean, * consider/retrieve values from.
* jwt: boolean, * @param {boolean} sources.config - Config.
* settings: boolean, * @param {boolean} jwt - JWT.
* urlParams: boolean * @param {boolean} settings - Settings.
* }} [sources] - A set/structure of {@code boolean} flags indicating the * @param {boolean} urlParams - URL parameters.
* configuration/preference/setting sources to consider/retrieve values from.
* @returns {any} * @returns {any}
*/ */
export function getPropertyValue( export function getPropertyValue(

View File

@ -14,7 +14,7 @@ export type TestHintProps = {
/** /**
* The indicator which determines whether the test mode is enabled. * The indicator which determines whether the test mode is enabled.
* {@link TestHint} components are rendered only if this flag is set to * {@link TestHint} Components are rendered only if this flag is set to
* {@code true}. * {@code true}.
*/ */
_testModeEnabled: boolean, _testModeEnabled: boolean,

View File

@ -20,7 +20,7 @@ type Props = {
* are the possible values: * are the possible values:
* 'conference.connectionEstablished' * 'conference.connectionEstablished'
* 'conference.connectionInterrupted' * 'conference.connectionInterrupted'
* 'conference.connectionRestored' * 'conference.connectionRestored'.
*/ */
_conferenceConnectionState: string, _conferenceConnectionState: string,

View File

@ -16,7 +16,7 @@ export type Props = {
/** /**
* Extra styles which will be applied in conjunction with `styles` or * Extra styles which will be applied in conjunction with `styles` or
* `toggledStyles` when the button is disabled; * `toggledStyles` when the button is disabled;.
*/ */
disabledStyles: ?Styles, disabledStyles: ?Styles,

Some files were not shown because too many files have changed in this diff Show More