Coding style: consistency, documentation comments, formatting

This commit is contained in:
Lyubo Marinov
2018-08-31 15:06:48 -05:00
committed by Любомир Маринов
parent 4283d8b342
commit e446acb045
4 changed files with 64 additions and 60 deletions

View File

@@ -5,9 +5,9 @@ import React, { Component } from 'react';
import { isFilmstripVisible } from '../../filmstrip';
import { LocalRecordingLabel } from '../../local-recording';
import { RecordingLabel } from '../../recording';
import { TranscribingLabel } from '../../transcribing';
import { shouldDisplayTileView } from '../../video-layout';
import { VideoQualityLabel } from '../../video-quality';
import { TranscribingLabel } from '../../transcribing/';
/**
* The type of the React {@code Component} props of {@link AbstractLabels}.
@@ -15,13 +15,13 @@ import { TranscribingLabel } from '../../transcribing/';
export type Props = {
/**
* Whether or not the filmstrip is displayed with remote videos. Used to
* determine display classes to set.
*/
* Whether the filmstrip is displayed with remote videos. Used to determine
* display classes to set.
*/
_filmstripVisible: boolean,
/**
* Whether or not the video quality label should be displayed.
* Whether the video quality label should be displayed.
*/
_showVideoQualityLabel: boolean
};
@@ -34,11 +34,23 @@ export type Props = {
*/
export default class AbstractLabels<P: Props, S> extends Component<P, S> {
/**
* Renders the {@code RecordingLabel} that is platform independent.
* Renders the {@code LocalRecordingLabel}.
*
* @protected
* @returns {React$Element}
*/
_renderLocalRecordingLabel() {
return (
<LocalRecordingLabel />
);
}
/**
* Renders the {@code RecordingLabel} that is platform independent.
*
* @param {string} mode - The recording mode that this label is rendered
* for.
* @protected
* @returns {React$Element}
*/
_renderRecordingLabel(mode: string) {
@@ -47,6 +59,18 @@ export default class AbstractLabels<P: Props, S> extends Component<P, S> {
);
}
/**
* Renders the {@code TranscribingLabel}.
*
* @protected
* @returns {React$Element}
*/
_renderTranscribingLabel() {
return (
<TranscribingLabel />
);
}
/**
* Renders the {@code VideoQualityLabel} that is platform independent.
*
@@ -58,37 +82,13 @@ export default class AbstractLabels<P: Props, S> extends Component<P, S> {
<VideoQualityLabel />
);
}
/**
* Renders the {@code TranscribingLabel}.
*
* @returns {React$Element}
* @protected
*/
_renderTranscribingLabel() {
return (
<TranscribingLabel />
);
}
/**
* Renders the {@code LocalRecordingLabel}.
*
* @returns {React$Element}
* @protected
*/
_renderLocalRecordingLabel() {
return (
<LocalRecordingLabel />
);
}
}
/**
* Maps (parts of) the Redux state to the associated props for the
* {@code Labels} component.
* Maps (parts of) the redux state to the associated props of the {@link Labels}
* {@code Component}.
*
* @param {Object} state - The Redux state.
* @param {Object} state - The redux state.
* @private
* @returns {{
* _filmstripVisible: boolean,